From 139fbf691a087264edee2fcac72716eba1884805 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 22 Jan 2024 14:33:39 +0000 Subject: [PATCH] deploy: 6de82646246f209870f9b89a7e093c6abe13eec6 --- 404.html | 4 +-- .../index.html | 14 +++++----- .../index.html | 14 +++++----- .../index.html | 14 +++++----- .../headstartwp_core.Comment/index.html | 4 +-- .../headstartwp_core.ConfigError/index.html | 6 ++-- .../headstartwp_core.Element/index.html | 4 +-- .../headstartwp_core.EndpointError/index.html | 6 ++-- .../headstartwp_core.FetchError/index.html | 6 ++-- .../index.html | 6 ++-- .../headstartwp_core.NotFoundError/index.html | 6 ++-- .../index.html | 14 +++++----- .../index.html | 14 +++++----- .../index.html | 4 +-- .../index.html | 14 +++++----- .../index.html | 14 +++++----- .../index.html | 14 +++++----- api/classes/headstartwp_core.Text/index.html | 4 +-- .../index.html | 14 +++++----- api/enums/headstartwp_core.LOGTYPE/index.html | 6 ++-- api/index.html | 4 +-- .../headstartwp_core.AppEntity/index.html | 6 ++-- .../index.html | 6 ++-- .../headstartwp_core.AuthorEntity/index.html | 6 ++-- .../headstartwp_core.AvatarUrls/index.html | 6 ++-- .../headstartwp_core.CommentEntity/index.html | 6 ++-- .../index.html | 6 ++-- .../headstartwp_core.Entity/index.html | 6 ++-- .../headstartwp_core.FetchOptions/index.html | 6 ++-- .../headstartwp_core.FetchResponse/index.html | 6 ++-- .../index.html | 8 +++--- .../index.html | 4 +-- .../headstartwp_core.Integration/index.html | 6 ++-- .../index.html | 6 ++-- .../headstartwp_core.PageEntity/index.html | 6 ++-- .../headstartwp_core.PageInfo/index.html | 6 ++-- .../index.html | 6 ++-- .../headstartwp_core.PostEntity/index.html | 6 ++-- .../index.html | 6 ++-- .../headstartwp_core.PostParams/index.html | 8 +++--- .../index.html | 6 ++-- .../index.html | 6 ++-- .../headstartwp_core.Rendered/index.html | 6 ++-- .../index.html | 6 ++-- .../headstartwp_core.SearchEntity/index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../headstartwp_core.TermEntity/index.html | 6 ++-- .../headstartwp_core.TypeEntity/index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 10 +++---- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../headstartwp_core.react.Colors/index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 8 +++--- .../headstartwp_core.react.IBlock/index.html | 8 +++--- .../index.html | 6 ++-- .../index.html | 8 +++--- .../index.html | 8 +++--- .../index.html | 8 +++--- .../index.html | 8 +++--- .../index.html | 8 +++--- .../index.html | 8 +++--- .../index.html | 4 +-- .../index.html | 8 +++--- .../index.html | 8 +++--- .../index.html | 8 +++--- .../index.html | 8 +++--- .../index.html | 8 +++--- .../index.html | 8 +++--- .../index.html | 8 +++--- .../index.html | 8 +++--- .../index.html | 8 +++--- .../index.html | 8 +++--- .../index.html | 8 +++--- .../index.html | 8 +++--- .../index.html | 8 +++--- .../index.html | 8 +++--- .../index.html | 8 +++--- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 4 +-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../index.html | 6 ++-- .../headstartwp_next.ImageProps/index.html | 6 ++-- .../index.html | 6 ++-- api/modules/headstartwp_core/index.html | 28 +++++++++---------- api/modules/headstartwp_next/index.html | 28 +++++++++---------- .../headstartwp_core.react/index.html | 10 +++---- .../headstartwp_next.config/index.html | 6 ++-- .../headstartwp_next.middlewares/index.html | 6 ++-- ...5d4a9.36624222.js => 0065d4a9.0892c98e.js} | 2 +- ...631a6.d11f19fc.js => 00a631a6.fb4b4afe.js} | 2 +- ...96e45.ba85b854.js => 00b96e45.dab39b10.js} | 2 +- ...54409.9db09290.js => 01354409.e867e768.js} | 2 +- ...f03e8.b0c86872.js => 016f03e8.47e0b40d.js} | 2 +- ...474ac.13dd2180.js => 042474ac.6372197f.js} | 2 +- ...26ff1.b11d3066.js => 09026ff1.c0799e18.js} | 2 +- ...53873.b51dab69.js => 09153873.04c9fc14.js} | 2 +- ...8c552.7ed47567.js => 0a88c552.21c42dfd.js} | 2 +- ...ccef1.ea605ee3.js => 0dbccef1.1c1afe51.js} | 2 +- ...f470d.c76ec246.js => 0f4f470d.9f672f3a.js} | 2 +- ...b7d82.c4ac105a.js => 0f7b7d82.281cf258.js} | 2 +- ...76796.390f4775.js => 10176796.2aca3f03.js} | 2 +- ...717b4.3aefb7f7.js => 126717b4.da4e2884.js} | 2 +- ...09991.021d9b0f.js => 15509991.f47a1013.js} | 2 +- ...c930b.17f8eb48.js => 173c930b.6f56b54b.js} | 2 +- ...7a900.c397d72c.js => 1937a900.c06c3bea.js} | 2 +- ...8a98a.3a7590a5.js => 19a8a98a.4970140a.js} | 2 +- ...7c9a6.191fdd7f.js => 1a87c9a6.d09f2bdc.js} | 2 +- ...e64df.25fef7d0.js => 1efe64df.2bd762a6.js} | 2 +- ...e2079.39f245e9.js => 1fbe2079.e9c597ef.js} | 2 +- ...672e4.6af35806.js => 20c672e4.a49b169d.js} | 2 +- ...565db.ee6d477b.js => 241565db.04469004.js} | 2 +- ...007dc.47a27898.js => 245007dc.3c87dac7.js} | 2 +- ...28c4e.50d6d344.js => 24728c4e.21b35f40.js} | 2 +- ...2b305.dd9d1d46.js => 2772b305.c7d93689.js} | 2 +- ...93857.bf18b9c7.js => 2cb93857.65f1c763.js} | 2 +- ...59592.2c56b68d.js => 2e459592.25c0ab11.js} | 2 +- ...d1272.57402a1d.js => 2f6d1272.8e91b8a4.js} | 2 +- ...47acf.31a798ea.js => 2f847acf.2e1d39d0.js} | 2 +- ...a1558.d5564eed.js => 312a1558.f38c9ca7.js} | 2 +- ...83884.8e63c825.js => 31d83884.2b83a6fb.js} | 2 +- ...3fc85.0845227d.js => 35c3fc85.97ca32b4.js} | 2 +- ...079cc.22aa4319.js => 37b079cc.78ea3a0b.js} | 2 +- ...12b40.a26c08aa.js => 37d12b40.82ad1805.js} | 2 +- ...f8e6f.17f02eb3.js => 37ef8e6f.b9af90f6.js} | 2 +- ...0e7b9.7579e018.js => 38f0e7b9.16106ab8.js} | 2 +- ...16a90.9ce89cf7.js => 3b216a90.41d44886.js} | 2 +- ...8897f.712ecfa4.js => 3d28897f.ed9bc0ce.js} | 2 +- ...9bd65.35d636a8.js => 44b9bd65.dfdcfcf4.js} | 2 +- ...017ad.f71f1c7c.js => 46c017ad.76c046fa.js} | 2 +- ...7697a.1f0a093a.js => 4727697a.8278edef.js} | 2 +- ...7042f.afe5797a.js => 4917042f.d759d732.js} | 2 +- ...cbdae.3d07fc78.js => 499cbdae.9ec183e5.js} | 2 +- ...b3b24.d55dc78c.js => 49db3b24.345b1b7b.js} | 2 +- ...d0a3d.0d95f4db.js => 4a0d0a3d.4afa3fa6.js} | 2 +- ...e8971.b1153eff.js => 4a5e8971.b2122ec9.js} | 2 +- ...be9cb.1e9de729.js => 4bbbe9cb.fba2d71f.js} | 2 +- ...3bdcd.bcb11960.js => 4bc3bdcd.b30cab50.js} | 2 +- ...c8e71.5cee6e5d.js => 4bfc8e71.90d5ea45.js} | 2 +- ...ded29.2f53ad25.js => 4c2ded29.fa6e5012.js} | 2 +- ...c32b5.e9a74569.js => 4e3c32b5.f32d8808.js} | 2 +- ...2b870.93d0d02f.js => 4e62b870.fafd8cea.js} | 2 +- ...6766f.204b4194.js => 4e86766f.d7880d47.js} | 2 +- ...55d51.da54fd73.js => 54355d51.7d44666d.js} | 2 +- ...19cbf.6ee5e421.js => 54d19cbf.c3ab9b70.js} | 2 +- ...ad7f7.e5682b04.js => 55dad7f7.c09dd4db.js} | 2 +- ...f4e5a.7d2b0ad2.js => 560f4e5a.ce124df2.js} | 2 +- ...7ca25.d309bce8.js => 5667ca25.390b42a1.js} | 2 +- ...df8aa.97d03213.js => 58adf8aa.e4330035.js} | 2 +- ...180a9.1739ee3b.js => 5a4180a9.a4526ed3.js} | 2 +- ...a4233.ba6d7430.js => 5bda4233.2368d2b0.js} | 2 +- ...e234e.84845489.js => 5e4e234e.18d30c00.js} | 2 +- ...6ed43.971c5225.js => 5ea6ed43.66e253a6.js} | 2 +- ...1d772.ba14be4e.js => 5fc1d772.6e1a97be.js} | 2 +- ...a3551.faa2cbd3.js => 637a3551.4a61de60.js} | 2 +- ...b7d90.3d8098f7.js => 66ab7d90.70f5cdd8.js} | 2 +- ...ecef0.254e0d92.js => 66decef0.6bf62550.js} | 2 +- ...e912d.9a0ba582.js => 670e912d.b60c023b.js} | 2 +- ...04a43.a8d61b25.js => 6e304a43.a5f32711.js} | 2 +- ...3ed71.0086750a.js => 6e83ed71.8009d85b.js} | 2 +- ...d7793.7c5d5d59.js => 6e8d7793.8b8330b9.js} | 2 +- ...b730f.1e34ea0d.js => 6eeb730f.6b29cf41.js} | 2 +- ...049a8.4b0a6f72.js => 6ef049a8.226af2d0.js} | 2 +- ...c2a10.f9cc4116.js => 704c2a10.538865f3.js} | 2 +- ...2e25f.aa3d5c59.js => 7272e25f.8e74f7a2.js} | 2 +- ...0f818.6f34bbed.js => 7360f818.46134336.js} | 2 +- ...dc397.87478ed7.js => 74bdc397.ef3d2d79.js} | 2 +- ...d5e23.b487bb5d.js => 76bd5e23.827d15f2.js} | 2 +- ...1a5b2.3536ebd6.js => 7721a5b2.efd3fd50.js} | 2 +- ...2af19.02e0a7e5.js => 7742af19.563b6b70.js} | 2 +- ...4975a.721e56dd.js => 7844975a.b09c5ed4.js} | 2 +- ...dd658.745c010b.js => 7d0dd658.1d885545.js} | 2 +- ...fdb35.a425ddea.js => 7d4fdb35.faed2d7f.js} | 2 +- ...2ea35.83254880.js => 8062ea35.fbdcd301.js} | 2 +- ...91c56.45e75f7e.js => 82691c56.55d18aa9.js} | 2 +- ...b8700.fc69fa8a.js => 829b8700.e48e1ef5.js} | 2 +- ...f0742.4c5b3e65.js => 84bf0742.35e23cfb.js} | 2 +- ...2dee1.2574078c.js => 8872dee1.cadc41e6.js} | 2 +- ...75f53.f6e2d1b2.js => 88a75f53.72952a9b.js} | 2 +- ...d0dd1.48dae2b4.js => 90fd0dd1.fbd0243a.js} | 2 +- ...e5e58.40a40afe.js => 912e5e58.95de57fa.js} | 2 +- ...b2d44.8d4d0d22.js => 92bb2d44.102156de.js} | 2 +- ...79912.7917b00a.js => 93679912.3d432960.js} | 2 +- ...ec5f2.65247023.js => 950ec5f2.629856cf.js} | 2 +- ...bca7a.49402b10.js => 960bca7a.61fc22ea.js} | 2 +- ...ac8d5.bb9c0fa3.js => 966ac8d5.ba372a6a.js} | 2 +- ...9b62a.cf24f134.js => 9689b62a.ce24ba9b.js} | 2 +- ...34eb5.d137e7e1.js => 96b34eb5.06a7e2db.js} | 2 +- ...8e328.a948eda4.js => 9818e328.62782006.js} | 2 +- ...cc669.6f884d04.js => 99fcc669.6414049d.js} | 2 +- ...33a19.74145b3b.js => 9be33a19.7c04ed84.js} | 2 +- ...6ae8c.9e67c269.js => 9c66ae8c.2b92896f.js} | 2 +- ...0f685.8a6337bb.js => a0d0f685.fb40aa1e.js} | 2 +- ...14d7c.53eb0878.js => a1514d7c.6d9dc475.js} | 2 +- ...2760f.b2a1f870.js => a222760f.b0496467.js} | 2 +- ...4918f.804be197.js => a304918f.5be855cd.js} | 2 +- ...5e611.0bad5a08.js => a3f5e611.a30addf5.js} | 2 +- ...ccb42.417a4f9b.js => a40ccb42.0ae62e0d.js} | 2 +- ...5c2b9.de1d9f66.js => a4f5c2b9.8aff1c6a.js} | 2 +- ...bba46.82d3b457.js => a56bba46.f146c7d9.js} | 2 +- ...c2626.b57a3f20.js => a56c2626.0a2d71dc.js} | 2 +- ...61116.13cb382d.js => ac461116.5cd6abbc.js} | 2 +- ...78953.63597942.js => ae778953.1c9d1a65.js} | 2 +- ...fd792.7cbff37d.js => b29fd792.a503b464.js} | 2 +- ...781c5.2ae54712.js => b2b781c5.772d2060.js} | 2 +- ...e5b9f.a082ff17.js => b2de5b9f.d3088901.js} | 2 +- ...7eed7.9f076cc3.js => bd37eed7.78530f2b.js} | 2 +- ...bc508.e061b9f9.js => bdcbc508.23ab3427.js} | 2 +- ...5ccb8.22c697da.js => c0c5ccb8.37f94642.js} | 2 +- ...c719f.bcb79b79.js => c10c719f.fb727937.js} | 2 +- ...f4659.7afa5927.js => c4bf4659.719fbaf6.js} | 2 +- ...a8848.9c549951.js => c75a8848.57239e56.js} | 2 +- ...9edca.8d2be2f0.js => c969edca.c6bdf25c.js} | 2 +- ...017d7.c32d1226.js => c9e017d7.42527c1a.js} | 2 +- ...267fc.18de701a.js => cb8267fc.324fbbbf.js} | 2 +- ...aa22f.c78ac3af.js => cf8aa22f.041c0abe.js} | 2 +- ...c6fcb.87bc1b59.js => cfec6fcb.c01b63b3.js} | 2 +- ...e169a.203892cd.js => d19e169a.f805290d.js} | 2 +- ...7ebfc.d3bab54b.js => d847ebfc.6bc109ac.js} | 2 +- ...415d1.8910ed97.js => d87415d1.0bcf814a.js} | 2 +- ...95696.8d6e61fc.js => d9995696.fcc0b3ba.js} | 2 +- ...3c1c7.6ff3e65b.js => d9f3c1c7.11627e4f.js} | 2 +- ...c5d89.be7d4547.js => dcac5d89.98136835.js} | 2 +- ...27140.adb6d360.js => def27140.fa9c7526.js} | 2 +- ...8eb77.e0b0e568.js => e088eb77.eaf95347.js} | 2 +- ...94716.a1646846.js => e4594716.4c67810e.js} | 2 +- ...8cb64.bbe73901.js => e518cb64.7e65a878.js} | 2 +- ...75807.9566d6f1.js => eb775807.a1a3e3cc.js} | 2 +- ...d967a.1ccf8935.js => ecbd967a.fc7951f6.js} | 2 +- ...11a1f.c4545799.js => ef311a1f.b9b0ba11.js} | 2 +- ...27269.7148769a.js => f1627269.d0fe9701.js} | 2 +- ...13ce1.088b6a2f.js => f2d13ce1.98103ef4.js} | 2 +- ...83cd4.44c665de.js => f3283cd4.8148c2ea.js} | 2 +- ...95041.7d8b3329.js => f3d95041.5de1a48c.js} | 2 +- ...c6fb7.de3efe0e.js => f46c6fb7.5915df3e.js} | 2 +- ...eec9e.7392531c.js => f78eec9e.d1316f62.js} | 2 +- ...6d01e.ef97e126.js => f9e6d01e.243e1eca.js} | 2 +- ...21d27.a875b6ae.js => fae21d27.934a1532.js} | 2 +- ...75763.9334f728.js => fb675763.18b74a00.js} | 2 +- ...b5c92.4d91bdcd.js => fd4b5c92.e4913e9f.js} | 2 +- ...n.504c95af.js => runtime~main.e8e157c5.js} | 2 +- index.html | 4 +-- learn/Guides/ab-test-link/index.html | 6 ++-- learn/Guides/linaria/index.html | 6 ++-- learn/Guides/typescript/index.html | 6 ++-- learn/Guides/youtube-facade/index.html | 6 ++-- .../creating-your-own-custom-hooks/index.html | 6 ++-- learn/data-fetching/index.html | 6 ++-- learn/data-fetching/prefetching/index.html | 6 ++-- .../use-post-or-posts/index.html | 6 ++-- learn/data-fetching/useSeo/index.html | 6 ++-- .../data-fetching/useauthorarchive/index.html | 6 ++-- learn/data-fetching/usepost/index.html | 6 ++-- learn/data-fetching/useposts/index.html | 6 ++-- learn/data-fetching/usesearch/index.html | 6 ++-- learn/data-fetching/useterms/index.html | 6 ++-- .../headless-config/index.html | 6 ++-- .../installing-wordpress-plugin/index.html | 6 ++-- learn/getting-started/quick-setup/index.html | 6 ++-- .../getting-started/quick-tutorial/index.html | 6 ++-- .../setting-up-manually/index.html | 6 ++-- .../index.html | 6 ++-- learn/gutenberg/rendering-blocks/index.html | 6 ++-- .../rendering-custom-blocks/index.html | 6 ++-- learn/index.html | 6 ++-- learn/utilities/sanitization/index.html | 6 ++-- .../basic-auth/index.html | 6 ++-- learn/wordpress-integration/feeds/index.html | 6 ++-- .../gutenberg/index.html | 6 ++-- .../multisite/index.html | 6 ++-- .../wordpress-integration/polylang/index.html | 6 ++-- .../wordpress-integration/previews/index.html | 6 ++-- .../revalidate/index.html | 6 ++-- philosophy/index.html | 4 +-- search-index.json | 2 +- search/index.html | 4 +-- 316 files changed, 717 insertions(+), 717 deletions(-) rename assets/js/{0065d4a9.36624222.js => 0065d4a9.0892c98e.js} (99%) rename assets/js/{00a631a6.d11f19fc.js => 00a631a6.fb4b4afe.js} (98%) rename assets/js/{00b96e45.ba85b854.js => 00b96e45.dab39b10.js} (88%) rename assets/js/{01354409.9db09290.js => 01354409.e867e768.js} (95%) rename assets/js/{016f03e8.b0c86872.js => 016f03e8.47e0b40d.js} (99%) rename assets/js/{042474ac.13dd2180.js => 042474ac.6372197f.js} (92%) rename assets/js/{09026ff1.b11d3066.js => 09026ff1.c0799e18.js} (96%) rename assets/js/{09153873.b51dab69.js => 09153873.04c9fc14.js} (93%) rename assets/js/{0a88c552.7ed47567.js => 0a88c552.21c42dfd.js} (94%) rename assets/js/{0dbccef1.ea605ee3.js => 0dbccef1.1c1afe51.js} (96%) rename assets/js/{0f4f470d.c76ec246.js => 0f4f470d.9f672f3a.js} (95%) rename assets/js/{0f7b7d82.c4ac105a.js => 0f7b7d82.281cf258.js} (93%) rename assets/js/{10176796.390f4775.js => 10176796.2aca3f03.js} (94%) rename assets/js/{126717b4.3aefb7f7.js => 126717b4.da4e2884.js} (98%) rename assets/js/{15509991.021d9b0f.js => 15509991.f47a1013.js} (99%) rename assets/js/{173c930b.17f8eb48.js => 173c930b.6f56b54b.js} (99%) rename assets/js/{1937a900.c397d72c.js => 1937a900.c06c3bea.js} (90%) rename assets/js/{19a8a98a.3a7590a5.js => 19a8a98a.4970140a.js} (91%) rename assets/js/{1a87c9a6.191fdd7f.js => 1a87c9a6.d09f2bdc.js} (85%) rename assets/js/{1efe64df.25fef7d0.js => 1efe64df.2bd762a6.js} (91%) rename assets/js/{1fbe2079.39f245e9.js => 1fbe2079.e9c597ef.js} (99%) rename assets/js/{20c672e4.6af35806.js => 20c672e4.a49b169d.js} (97%) rename assets/js/{241565db.ee6d477b.js => 241565db.04469004.js} (97%) rename assets/js/{245007dc.47a27898.js => 245007dc.3c87dac7.js} (96%) rename assets/js/{24728c4e.50d6d344.js => 24728c4e.21b35f40.js} (96%) rename assets/js/{2772b305.dd9d1d46.js => 2772b305.c7d93689.js} (90%) rename assets/js/{2cb93857.bf18b9c7.js => 2cb93857.65f1c763.js} (99%) rename assets/js/{2e459592.2c56b68d.js => 2e459592.25c0ab11.js} (96%) rename assets/js/{2f6d1272.57402a1d.js => 2f6d1272.8e91b8a4.js} (98%) rename assets/js/{2f847acf.31a798ea.js => 2f847acf.2e1d39d0.js} (96%) rename assets/js/{312a1558.d5564eed.js => 312a1558.f38c9ca7.js} (95%) rename assets/js/{31d83884.8e63c825.js => 31d83884.2b83a6fb.js} (88%) rename assets/js/{35c3fc85.0845227d.js => 35c3fc85.97ca32b4.js} (93%) rename assets/js/{37b079cc.22aa4319.js => 37b079cc.78ea3a0b.js} (92%) rename assets/js/{37d12b40.a26c08aa.js => 37d12b40.82ad1805.js} (89%) rename assets/js/{37ef8e6f.17f02eb3.js => 37ef8e6f.b9af90f6.js} (99%) rename assets/js/{38f0e7b9.7579e018.js => 38f0e7b9.16106ab8.js} (95%) rename assets/js/{3b216a90.9ce89cf7.js => 3b216a90.41d44886.js} (99%) rename assets/js/{3d28897f.712ecfa4.js => 3d28897f.ed9bc0ce.js} (90%) rename assets/js/{44b9bd65.35d636a8.js => 44b9bd65.dfdcfcf4.js} (97%) rename assets/js/{46c017ad.f71f1c7c.js => 46c017ad.76c046fa.js} (98%) rename assets/js/{4727697a.1f0a093a.js => 4727697a.8278edef.js} (92%) rename assets/js/{4917042f.afe5797a.js => 4917042f.d759d732.js} (96%) rename assets/js/{499cbdae.3d07fc78.js => 499cbdae.9ec183e5.js} (98%) rename assets/js/{49db3b24.d55dc78c.js => 49db3b24.345b1b7b.js} (94%) rename assets/js/{4a0d0a3d.0d95f4db.js => 4a0d0a3d.4afa3fa6.js} (95%) rename assets/js/{4a5e8971.b1153eff.js => 4a5e8971.b2122ec9.js} (94%) rename assets/js/{4bbbe9cb.1e9de729.js => 4bbbe9cb.fba2d71f.js} (97%) rename assets/js/{4bc3bdcd.bcb11960.js => 4bc3bdcd.b30cab50.js} (97%) rename assets/js/{4bfc8e71.5cee6e5d.js => 4bfc8e71.90d5ea45.js} (98%) rename assets/js/{4c2ded29.2f53ad25.js => 4c2ded29.fa6e5012.js} (96%) rename assets/js/{4e3c32b5.e9a74569.js => 4e3c32b5.f32d8808.js} (99%) rename assets/js/{4e62b870.93d0d02f.js => 4e62b870.fafd8cea.js} (96%) rename assets/js/{4e86766f.204b4194.js => 4e86766f.d7880d47.js} (96%) rename assets/js/{54355d51.da54fd73.js => 54355d51.7d44666d.js} (96%) rename assets/js/{54d19cbf.6ee5e421.js => 54d19cbf.c3ab9b70.js} (99%) rename assets/js/{55dad7f7.e5682b04.js => 55dad7f7.c09dd4db.js} (99%) rename assets/js/{560f4e5a.7d2b0ad2.js => 560f4e5a.ce124df2.js} (99%) rename assets/js/{5667ca25.d309bce8.js => 5667ca25.390b42a1.js} (92%) rename assets/js/{58adf8aa.97d03213.js => 58adf8aa.e4330035.js} (98%) rename assets/js/{5a4180a9.1739ee3b.js => 5a4180a9.a4526ed3.js} (98%) rename assets/js/{5bda4233.ba6d7430.js => 5bda4233.2368d2b0.js} (92%) rename assets/js/{5e4e234e.84845489.js => 5e4e234e.18d30c00.js} (95%) rename assets/js/{5ea6ed43.971c5225.js => 5ea6ed43.66e253a6.js} (98%) rename assets/js/{5fc1d772.ba14be4e.js => 5fc1d772.6e1a97be.js} (98%) rename assets/js/{637a3551.faa2cbd3.js => 637a3551.4a61de60.js} (95%) rename assets/js/{66ab7d90.3d8098f7.js => 66ab7d90.70f5cdd8.js} (96%) rename assets/js/{66decef0.254e0d92.js => 66decef0.6bf62550.js} (97%) rename assets/js/{670e912d.9a0ba582.js => 670e912d.b60c023b.js} (98%) rename assets/js/{6e304a43.a8d61b25.js => 6e304a43.a5f32711.js} (97%) rename assets/js/{6e83ed71.0086750a.js => 6e83ed71.8009d85b.js} (96%) rename assets/js/{6e8d7793.7c5d5d59.js => 6e8d7793.8b8330b9.js} (99%) rename assets/js/{6eeb730f.1e34ea0d.js => 6eeb730f.6b29cf41.js} (95%) rename assets/js/{6ef049a8.4b0a6f72.js => 6ef049a8.226af2d0.js} (90%) rename assets/js/{704c2a10.f9cc4116.js => 704c2a10.538865f3.js} (98%) rename assets/js/{7272e25f.aa3d5c59.js => 7272e25f.8e74f7a2.js} (96%) rename assets/js/{7360f818.6f34bbed.js => 7360f818.46134336.js} (91%) rename assets/js/{74bdc397.87478ed7.js => 74bdc397.ef3d2d79.js} (89%) rename assets/js/{76bd5e23.b487bb5d.js => 76bd5e23.827d15f2.js} (96%) rename assets/js/{7721a5b2.3536ebd6.js => 7721a5b2.efd3fd50.js} (99%) rename assets/js/{7742af19.02e0a7e5.js => 7742af19.563b6b70.js} (95%) rename assets/js/{7844975a.721e56dd.js => 7844975a.b09c5ed4.js} (97%) rename assets/js/{7d0dd658.745c010b.js => 7d0dd658.1d885545.js} (90%) rename assets/js/{7d4fdb35.a425ddea.js => 7d4fdb35.faed2d7f.js} (90%) rename assets/js/{8062ea35.83254880.js => 8062ea35.fbdcd301.js} (98%) rename assets/js/{82691c56.45e75f7e.js => 82691c56.55d18aa9.js} (99%) rename assets/js/{829b8700.fc69fa8a.js => 829b8700.e48e1ef5.js} (97%) rename assets/js/{84bf0742.4c5b3e65.js => 84bf0742.35e23cfb.js} (97%) rename assets/js/{8872dee1.2574078c.js => 8872dee1.cadc41e6.js} (98%) rename assets/js/{88a75f53.f6e2d1b2.js => 88a75f53.72952a9b.js} (94%) rename assets/js/{90fd0dd1.48dae2b4.js => 90fd0dd1.fbd0243a.js} (95%) rename assets/js/{912e5e58.40a40afe.js => 912e5e58.95de57fa.js} (84%) rename assets/js/{92bb2d44.8d4d0d22.js => 92bb2d44.102156de.js} (97%) rename assets/js/{93679912.7917b00a.js => 93679912.3d432960.js} (97%) rename assets/js/{950ec5f2.65247023.js => 950ec5f2.629856cf.js} (96%) rename assets/js/{960bca7a.49402b10.js => 960bca7a.61fc22ea.js} (94%) rename assets/js/{966ac8d5.bb9c0fa3.js => 966ac8d5.ba372a6a.js} (90%) rename assets/js/{9689b62a.cf24f134.js => 9689b62a.ce24ba9b.js} (82%) rename assets/js/{96b34eb5.d137e7e1.js => 96b34eb5.06a7e2db.js} (95%) rename assets/js/{9818e328.a948eda4.js => 9818e328.62782006.js} (88%) rename assets/js/{99fcc669.6f884d04.js => 99fcc669.6414049d.js} (99%) rename assets/js/{9be33a19.74145b3b.js => 9be33a19.7c04ed84.js} (90%) rename assets/js/{9c66ae8c.9e67c269.js => 9c66ae8c.2b92896f.js} (99%) rename assets/js/{a0d0f685.8a6337bb.js => a0d0f685.fb40aa1e.js} (95%) rename assets/js/{a1514d7c.53eb0878.js => a1514d7c.6d9dc475.js} (92%) rename assets/js/{a222760f.b2a1f870.js => a222760f.b0496467.js} (99%) rename assets/js/{a304918f.804be197.js => a304918f.5be855cd.js} (92%) rename assets/js/{a3f5e611.0bad5a08.js => a3f5e611.a30addf5.js} (94%) rename assets/js/{a40ccb42.417a4f9b.js => a40ccb42.0ae62e0d.js} (97%) rename assets/js/{a4f5c2b9.de1d9f66.js => a4f5c2b9.8aff1c6a.js} (85%) rename assets/js/{a56bba46.82d3b457.js => a56bba46.f146c7d9.js} (85%) rename assets/js/{a56c2626.b57a3f20.js => a56c2626.0a2d71dc.js} (98%) rename assets/js/{ac461116.13cb382d.js => ac461116.5cd6abbc.js} (96%) rename assets/js/{ae778953.63597942.js => ae778953.1c9d1a65.js} (97%) rename assets/js/{b29fd792.7cbff37d.js => b29fd792.a503b464.js} (90%) rename assets/js/{b2b781c5.2ae54712.js => b2b781c5.772d2060.js} (97%) rename assets/js/{b2de5b9f.a082ff17.js => b2de5b9f.d3088901.js} (86%) rename assets/js/{bd37eed7.9f076cc3.js => bd37eed7.78530f2b.js} (92%) rename assets/js/{bdcbc508.e061b9f9.js => bdcbc508.23ab3427.js} (89%) rename assets/js/{c0c5ccb8.22c697da.js => c0c5ccb8.37f94642.js} (98%) rename assets/js/{c10c719f.bcb79b79.js => c10c719f.fb727937.js} (98%) rename assets/js/{c4bf4659.7afa5927.js => c4bf4659.719fbaf6.js} (88%) rename assets/js/{c75a8848.9c549951.js => c75a8848.57239e56.js} (96%) rename assets/js/{c969edca.8d2be2f0.js => c969edca.c6bdf25c.js} (96%) rename assets/js/{c9e017d7.c32d1226.js => c9e017d7.42527c1a.js} (98%) rename assets/js/{cb8267fc.18de701a.js => cb8267fc.324fbbbf.js} (77%) rename assets/js/{cf8aa22f.c78ac3af.js => cf8aa22f.041c0abe.js} (91%) rename assets/js/{cfec6fcb.87bc1b59.js => cfec6fcb.c01b63b3.js} (98%) rename assets/js/{d19e169a.203892cd.js => d19e169a.f805290d.js} (98%) rename assets/js/{d847ebfc.d3bab54b.js => d847ebfc.6bc109ac.js} (99%) rename assets/js/{d87415d1.8910ed97.js => d87415d1.0bcf814a.js} (99%) rename assets/js/{d9995696.8d6e61fc.js => d9995696.fcc0b3ba.js} (98%) rename assets/js/{d9f3c1c7.6ff3e65b.js => d9f3c1c7.11627e4f.js} (97%) rename assets/js/{dcac5d89.be7d4547.js => dcac5d89.98136835.js} (98%) rename assets/js/{def27140.adb6d360.js => def27140.fa9c7526.js} (97%) rename assets/js/{e088eb77.e0b0e568.js => e088eb77.eaf95347.js} (96%) rename assets/js/{e4594716.a1646846.js => e4594716.4c67810e.js} (97%) rename assets/js/{e518cb64.bbe73901.js => e518cb64.7e65a878.js} (97%) rename assets/js/{eb775807.9566d6f1.js => eb775807.a1a3e3cc.js} (93%) rename assets/js/{ecbd967a.1ccf8935.js => ecbd967a.fc7951f6.js} (98%) rename assets/js/{ef311a1f.c4545799.js => ef311a1f.b9b0ba11.js} (89%) rename assets/js/{f1627269.7148769a.js => f1627269.d0fe9701.js} (98%) rename assets/js/{f2d13ce1.088b6a2f.js => f2d13ce1.98103ef4.js} (96%) rename assets/js/{f3283cd4.44c665de.js => f3283cd4.8148c2ea.js} (99%) rename assets/js/{f3d95041.7d8b3329.js => f3d95041.5de1a48c.js} (99%) rename assets/js/{f46c6fb7.de3efe0e.js => f46c6fb7.5915df3e.js} (96%) rename assets/js/{f78eec9e.7392531c.js => f78eec9e.d1316f62.js} (91%) rename assets/js/{f9e6d01e.ef97e126.js => f9e6d01e.243e1eca.js} (86%) rename assets/js/{fae21d27.a875b6ae.js => fae21d27.934a1532.js} (98%) rename assets/js/{fb675763.9334f728.js => fb675763.18b74a00.js} (99%) rename assets/js/{fd4b5c92.4d91bdcd.js => fd4b5c92.e4913e9f.js} (91%) rename assets/js/{runtime~main.504c95af.js => runtime~main.e8e157c5.js} (57%) diff --git a/404.html b/404.html index 222cc7c31..ec2595fc1 100644 --- a/404.html +++ b/404.html @@ -7,13 +7,13 @@ - +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

- + \ No newline at end of file diff --git a/api/classes/headstartwp_core.AbstractFetchStrategy/index.html b/api/classes/headstartwp_core.AbstractFetchStrategy/index.html index da9f90797..ac23c66e0 100644 --- a/api/classes/headstartwp_core.AbstractFetchStrategy/index.html +++ b/api/classes/headstartwp_core.AbstractFetchStrategy/index.html @@ -7,18 +7,18 @@ - +
Skip to main content

Class: AbstractFetchStrategy<E, Params, R>

@headstartwp/core.AbstractFetchStrategy

Abstract class that lays out a strategy for fetching data

All Fetch Strategies should implement this class and it allows to share logic for fetching data both -on the front-end and on the back-end.

Type parameters

NameTypeDescription
EEThe type of entity that is fetched (e.g PostEntity, TermEntity etc)
Paramsextends EndpointParamsThe type of the params that are passed to the endpoint
RE-

Hierarchy

Constructors

constructor

new AbstractFetchStrategy<E, Params, R>(baseURL?, defaultParams?)

The strategy constructor

Type parameters

NameType
EE
Paramsextends EndpointParams
RE

Parameters

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<Params>(optional) list of default params

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

Properties

baseURL

baseURL: string = ''

The base URL where the API is located

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:115


defaultParams

defaultParams: Partial<Params> = {}

The Default Params

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:105


endpoint

endpoint: string = ''

Holds the current endpoint for the strategy

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:110

Methods

buildEndpointURL

buildEndpointURL(params): string

Builds the final endpoint URL based on the passed parameters

Parameters

NameTypeDescription
paramsPartial<Params>The params to add to the request

Returns

string

The endpoint URL.

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:206


fetcher

fetcher(url, params, options?): Promise<FetchResponse<R>>

The default fetcher function

The default fetcher function handles authentication headers and errors from the API.

A custom strategy can override this function to run additional logic before or after the fetch call

Parameters

NameTypeDescription
urlstringThe URL to fetch
paramsPartial<Params>The request params
optionsPartial<FetchOptions>The fetcher options

Returns

Promise<FetchResponse<R>>

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:261


filterData

filterData(data, filterOptions?): FetchResponse<R>

Filters the data returned from the API by excluding fields that are not needed in order to reduce -payload size.

Parameters

NameTypeDescription
dataFetchResponse<R>The data to filter
filterOptions?FilterDataOptions<R>Filter options

Returns

FetchResponse<R>

The filtered data

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:339


get

get(params?): Promise<FetchResponse<R>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters

NameTypeDescription
paramsPartial<Params>The endpoint params

Returns

Promise<FetchResponse<R>>

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:404


getAuthHeader

getAuthHeader(options?): string

Parameters

NameType
optionsPartial<FetchOptions>

Returns

string

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:227


getCacheKey

getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters

NameTypeDescription
paramsPartial<Params>The request params

Returns

Object

The cache key object

NameType
argsPartial<Params> & { sourceUrl: string }
urlstring

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:369


getDefaultEndpoint

Abstract getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint -for the strategy

Returns

string

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:121


getDefaultParams

getDefaultParams(): Partial<Params>

Returns

Partial<Params>

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:168


getEndpoint

getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, -returns the default endpoint

Returns

string

The current endpoint for the strategy

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160


getParamsFromURL

Abstract getParamsFromURL(path, nonUrlParams): Partial<Params>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support -mapping url params to endpoint params, it should return an empty object.

Parameters

NameTypeDescription
pathstringThe Path name
nonUrlParamsPartial<Params>The non-url params

Returns

Partial<Params>

params extracted from the URL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:183


getQueriedObject

getQueriedObject(response, params): Object

Parameters

NameType
responseFetchResponse<E>
paramsPartial<Params>

Returns

Object

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:327


isMainQuery

isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<Params>The non-url params

Returns

boolean

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:191


normalizeForCache

normalizeForCache(data, params): NormalizedDataForCache<R, Params>

Normalize data for cache.

Parameters

NameTypeDescription
dataFetchResponse<R>The fetch response data
paramsPartial<Params>The request params

Returns

NormalizedDataForCache<R, Params>

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:379


prepareResponse

prepareResponse(response, params): FetchResponse<R>

Parameters

NameType
responseFetchResponse<E>
paramsPartial<Params>

Returns

FetchResponse<R>

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:219


setBaseURL

setBaseURL(url?): void

Parameters

NameTypeDefault value
urlundefined | string''

Returns

void

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:150


setEndpoint

setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters

NameTypeDescription
endpointstringThe endpoint to fetch

Returns

void

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:146

- +on the front-end and on the back-end.

Type parameters

NameTypeDescription
EEThe type of entity that is fetched (e.g PostEntity, TermEntity etc)
Paramsextends EndpointParamsThe type of the params that are passed to the endpoint
RE-

Hierarchy

Constructors

constructor

new AbstractFetchStrategy<E, Params, R>(baseURL?, defaultParams?)

The strategy constructor

Type parameters

NameType
EE
Paramsextends EndpointParams
RE

Parameters

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<Params>(optional) list of default params

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

Properties

baseURL

baseURL: string = ''

The base URL where the API is located

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:115


defaultParams

defaultParams: Partial<Params> = {}

The Default Params

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:105


endpoint

endpoint: string = ''

Holds the current endpoint for the strategy

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:110

Methods

buildEndpointURL

buildEndpointURL(params): string

Builds the final endpoint URL based on the passed parameters

Parameters

NameTypeDescription
paramsPartial<Params>The params to add to the request

Returns

string

The endpoint URL.

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:206


fetcher

fetcher(url, params, options?): Promise<FetchResponse<R>>

The default fetcher function

The default fetcher function handles authentication headers and errors from the API.

A custom strategy can override this function to run additional logic before or after the fetch call

Parameters

NameTypeDescription
urlstringThe URL to fetch
paramsPartial<Params>The request params
optionsPartial<FetchOptions>The fetcher options

Returns

Promise<FetchResponse<R>>

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:261


filterData

filterData(data, filterOptions?): FetchResponse<R>

Filters the data returned from the API by excluding fields that are not needed in order to reduce +payload size.

Parameters

NameTypeDescription
dataFetchResponse<R>The data to filter
filterOptions?FilterDataOptions<R>Filter options

Returns

FetchResponse<R>

The filtered data

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:339


get

get(params?): Promise<FetchResponse<R>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters

NameTypeDescription
paramsPartial<Params>The endpoint params

Returns

Promise<FetchResponse<R>>

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:404


getAuthHeader

getAuthHeader(options?): string

Parameters

NameType
optionsPartial<FetchOptions>

Returns

string

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:227


getCacheKey

getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters

NameTypeDescription
paramsPartial<Params>The request params

Returns

Object

The cache key object

NameType
argsPartial<Params> & { sourceUrl: string }
urlstring

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:369


getDefaultEndpoint

Abstract getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint +for the strategy

Returns

string

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:121


getDefaultParams

getDefaultParams(): Partial<Params>

Returns

Partial<Params>

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:168


getEndpoint

getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, +returns the default endpoint

Returns

string

The current endpoint for the strategy

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160


getParamsFromURL

Abstract getParamsFromURL(path, nonUrlParams): Partial<Params>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support +mapping url params to endpoint params, it should return an empty object.

Parameters

NameTypeDescription
pathstringThe Path name
nonUrlParamsPartial<Params>The non-url params

Returns

Partial<Params>

params extracted from the URL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:183


getQueriedObject

getQueriedObject(response, params): Object

Parameters

NameType
responseFetchResponse<E>
paramsPartial<Params>

Returns

Object

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:327


isMainQuery

isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<Params>The non-url params

Returns

boolean

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:191


normalizeForCache

normalizeForCache(data, params): NormalizedDataForCache<R, Params>

Normalize data for cache.

Parameters

NameTypeDescription
dataFetchResponse<R>The fetch response data
paramsPartial<Params>The request params

Returns

NormalizedDataForCache<R, Params>

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:379


prepareResponse

prepareResponse(response, params): FetchResponse<R>

Parameters

NameType
responseFetchResponse<E>
paramsPartial<Params>

Returns

FetchResponse<R>

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:219


setBaseURL

setBaseURL(url?): void

Parameters

NameTypeDefault value
urlundefined | string''

Returns

void

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:150


setEndpoint

setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters

NameTypeDescription
endpointstringThe endpoint to fetch

Returns

void

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:146

+ \ No newline at end of file diff --git a/api/classes/headstartwp_core.AppSettingsStrategy/index.html b/api/classes/headstartwp_core.AppSettingsStrategy/index.html index 8ebb1ce4d..71c01239e 100644 --- a/api/classes/headstartwp_core.AppSettingsStrategy/index.html +++ b/api/classes/headstartwp_core.AppSettingsStrategy/index.html @@ -7,18 +7,18 @@ - +
Skip to main content

Class: AppSettingsStrategy<T, P>

@headstartwp/core.AppSettingsStrategy

The App Settings strategy is used to fetch the app settings endpoints exposed by the -headless wp plugin

Type parameters

NameType
Textends AppEntity = AppEntity
Pextends EndpointParams = EndpointParams

Hierarchy

Constructors

constructor

new AppSettingsStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters

NameType
Textends AppEntity = AppEntity
Pextends EndpointParams = EndpointParams

Parameters

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from

AbstractFetchStrategy.constructor

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

Properties

baseURL

baseURL: string = ''

The base URL where the API is located

Inherited from

AbstractFetchStrategy.baseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:115


defaultParams

defaultParams: Partial<P> = {}

The Default Params

Inherited from

AbstractFetchStrategy.defaultParams

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:105


endpoint

endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from

AbstractFetchStrategy.endpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:110

Methods

buildEndpointURL

buildEndpointURL(params): string

Builds the final endpoint URL based on the passed parameters

Parameters

NameTypeDescription
paramsPartial<P>The params to add to the request

Returns

string

The endpoint URL.

Inherited from

AbstractFetchStrategy.buildEndpointURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:206


fetcher

fetcher(url, params, options?): Promise<FetchResponse<T>>

The default fetcher function

The default fetcher function handles authentication headers and errors from the API.

A custom strategy can override this function to run additional logic before or after the fetch call

Parameters

NameTypeDescription
urlstringThe URL to fetch
paramsPartial<P>The request params
optionsPartial<FetchOptions>The fetcher options

Returns

Promise<FetchResponse<T>>

Inherited from

AbstractFetchStrategy.fetcher

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:261


filterData

filterData(data, filterOptions?): FetchResponse<T>

Filters the data returned from the API by excluding fields that are not needed in order to reduce -payload size.

Parameters

NameTypeDescription
dataFetchResponse<T>The data to filter
filterOptions?FilterDataOptions<T>Filter options

Returns

FetchResponse<T>

The filtered data

Inherited from

AbstractFetchStrategy.filterData

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:339


get

get(params?): Promise<FetchResponse<T>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters

NameTypeDescription
paramsPartial<P>The endpoint params

Returns

Promise<FetchResponse<T>>

Inherited from

AbstractFetchStrategy.get

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:404


getAuthHeader

getAuthHeader(options?): string

Parameters

NameType
optionsPartial<FetchOptions>

Returns

string

Inherited from

AbstractFetchStrategy.getAuthHeader

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:227


getCacheKey

getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters

NameTypeDescription
paramsPartial<P>The request params

Returns

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from

AbstractFetchStrategy.getCacheKey

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:369


getDefaultEndpoint

getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint -for the strategy

Returns

string

Overrides

AbstractFetchStrategy.getDefaultEndpoint

Defined in

packages/core/src/data/strategies/AppSettingsStrategy.ts:15


getDefaultParams

getDefaultParams(): Partial<P>

Returns

Partial<P>

Inherited from

AbstractFetchStrategy.getDefaultParams

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:168


getEndpoint

getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, -returns the default endpoint

Returns

string

The current endpoint for the strategy

Inherited from

AbstractFetchStrategy.getEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160


getParamsFromURL

getParamsFromURL(path, params?): Partial<P>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support -mapping url params to endpoint params, it should return an empty object.

Parameters

NameTypeDescription
pathstringThe Path name
paramsPartial<P>The non-url params

Returns

Partial<P>

params extracted from the URL

Overrides

AbstractFetchStrategy.getParamsFromURL

Defined in

packages/core/src/data/strategies/AppSettingsStrategy.ts:20


getQueriedObject

getQueriedObject(response, params): Object

Parameters

NameType
responseFetchResponse<T>
paramsPartial<P>

Returns

Object

Inherited from

AbstractFetchStrategy.getQueriedObject

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:327


isMainQuery

isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns

boolean

Inherited from

AbstractFetchStrategy.isMainQuery

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:191


normalizeForCache

normalizeForCache(data, params): NormalizedDataForCache<T, P>

Normalize data for cache.

Parameters

NameTypeDescription
dataFetchResponse<T>The fetch response data
paramsPartial<P>The request params

Returns

NormalizedDataForCache<T, P>

Inherited from

AbstractFetchStrategy.normalizeForCache

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:379


prepareResponse

prepareResponse(response, params): FetchResponse<T>

Parameters

NameType
responseFetchResponse<T>
paramsPartial<P>

Returns

FetchResponse<T>

Inherited from

AbstractFetchStrategy.prepareResponse

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:219


setBaseURL

setBaseURL(url?): void

Parameters

NameTypeDefault value
urlundefined | string''

Returns

void

Inherited from

AbstractFetchStrategy.setBaseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:150


setEndpoint

setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters

NameTypeDescription
endpointstringThe endpoint to fetch

Returns

void

Inherited from

AbstractFetchStrategy.setEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:146

- +headless wp plugin

Type parameters

NameType
Textends AppEntity = AppEntity
Pextends EndpointParams = EndpointParams

Hierarchy

Constructors

constructor

new AppSettingsStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters

NameType
Textends AppEntity = AppEntity
Pextends EndpointParams = EndpointParams

Parameters

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from

AbstractFetchStrategy.constructor

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

Properties

baseURL

baseURL: string = ''

The base URL where the API is located

Inherited from

AbstractFetchStrategy.baseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:115


defaultParams

defaultParams: Partial<P> = {}

The Default Params

Inherited from

AbstractFetchStrategy.defaultParams

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:105


endpoint

endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from

AbstractFetchStrategy.endpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:110

Methods

buildEndpointURL

buildEndpointURL(params): string

Builds the final endpoint URL based on the passed parameters

Parameters

NameTypeDescription
paramsPartial<P>The params to add to the request

Returns

string

The endpoint URL.

Inherited from

AbstractFetchStrategy.buildEndpointURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:206


fetcher

fetcher(url, params, options?): Promise<FetchResponse<T>>

The default fetcher function

The default fetcher function handles authentication headers and errors from the API.

A custom strategy can override this function to run additional logic before or after the fetch call

Parameters

NameTypeDescription
urlstringThe URL to fetch
paramsPartial<P>The request params
optionsPartial<FetchOptions>The fetcher options

Returns

Promise<FetchResponse<T>>

Inherited from

AbstractFetchStrategy.fetcher

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:261


filterData

filterData(data, filterOptions?): FetchResponse<T>

Filters the data returned from the API by excluding fields that are not needed in order to reduce +payload size.

Parameters

NameTypeDescription
dataFetchResponse<T>The data to filter
filterOptions?FilterDataOptions<T>Filter options

Returns

FetchResponse<T>

The filtered data

Inherited from

AbstractFetchStrategy.filterData

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:339


get

get(params?): Promise<FetchResponse<T>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters

NameTypeDescription
paramsPartial<P>The endpoint params

Returns

Promise<FetchResponse<T>>

Inherited from

AbstractFetchStrategy.get

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:404


getAuthHeader

getAuthHeader(options?): string

Parameters

NameType
optionsPartial<FetchOptions>

Returns

string

Inherited from

AbstractFetchStrategy.getAuthHeader

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:227


getCacheKey

getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters

NameTypeDescription
paramsPartial<P>The request params

Returns

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from

AbstractFetchStrategy.getCacheKey

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:369


getDefaultEndpoint

getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint +for the strategy

Returns

string

Overrides

AbstractFetchStrategy.getDefaultEndpoint

Defined in

packages/core/src/data/strategies/AppSettingsStrategy.ts:15


getDefaultParams

getDefaultParams(): Partial<P>

Returns

Partial<P>

Inherited from

AbstractFetchStrategy.getDefaultParams

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:168


getEndpoint

getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, +returns the default endpoint

Returns

string

The current endpoint for the strategy

Inherited from

AbstractFetchStrategy.getEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160


getParamsFromURL

getParamsFromURL(path, params?): Partial<P>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support +mapping url params to endpoint params, it should return an empty object.

Parameters

NameTypeDescription
pathstringThe Path name
paramsPartial<P>The non-url params

Returns

Partial<P>

params extracted from the URL

Overrides

AbstractFetchStrategy.getParamsFromURL

Defined in

packages/core/src/data/strategies/AppSettingsStrategy.ts:20


getQueriedObject

getQueriedObject(response, params): Object

Parameters

NameType
responseFetchResponse<T>
paramsPartial<P>

Returns

Object

Inherited from

AbstractFetchStrategy.getQueriedObject

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:327


isMainQuery

isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns

boolean

Inherited from

AbstractFetchStrategy.isMainQuery

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:191


normalizeForCache

normalizeForCache(data, params): NormalizedDataForCache<T, P>

Normalize data for cache.

Parameters

NameTypeDescription
dataFetchResponse<T>The fetch response data
paramsPartial<P>The request params

Returns

NormalizedDataForCache<T, P>

Inherited from

AbstractFetchStrategy.normalizeForCache

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:379


prepareResponse

prepareResponse(response, params): FetchResponse<T>

Parameters

NameType
responseFetchResponse<T>
paramsPartial<P>

Returns

FetchResponse<T>

Inherited from

AbstractFetchStrategy.prepareResponse

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:219


setBaseURL

setBaseURL(url?): void

Parameters

NameTypeDefault value
urlundefined | string''

Returns

void

Inherited from

AbstractFetchStrategy.setBaseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:150


setEndpoint

setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters

NameTypeDescription
endpointstringThe endpoint to fetch

Returns

void

Inherited from

AbstractFetchStrategy.setEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:146

+ \ No newline at end of file diff --git a/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/index.html b/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/index.html index 96486a371..6e4ffd02b 100644 --- a/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/index.html +++ b/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/index.html @@ -7,17 +7,17 @@ - +
-
Skip to main content

Class: AuthorArchiveFetchStrategy<T, P>

@headstartwp/core.AuthorArchiveFetchStrategy

The AuthorArchiveFetchStrategy extends the PostsArchiveFetchStrategy and performs author archive requests

This strategy supports extracting endpoint params from url E.g:

  • /author-name/ maps to { author: 'author-name' }
  • /author-name/page/2 maps to { author: 'author-name', page: 2 }

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Hierarchy

Constructors

constructor

new AuthorArchiveFetchStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from

PostsArchiveFetchStrategy.constructor

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

Properties

baseURL

baseURL: string = ''

The base URL where the API is located

Inherited from

PostsArchiveFetchStrategy.baseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:115


defaultParams

defaultParams: Partial<P> = {}

The Default Params

Inherited from

PostsArchiveFetchStrategy.defaultParams

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:105


endpoint

endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from

PostsArchiveFetchStrategy.endpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:110


locale

locale: string = ''

Inherited from

PostsArchiveFetchStrategy.locale

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212


path

path: string = ''

Inherited from

PostsArchiveFetchStrategy.path

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210

Methods

buildEndpointURL

buildEndpointURL(params): string

Handles taxonomy filters and switch endpoint based on post type

Parameters

NameTypeDescription
paramsPartial<P>The params to build the endpoint with

Returns

string

Inherited from

PostsArchiveFetchStrategy.buildEndpointURL

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289


fetcher

fetcher(url, params, options?): Promise<FetchResponse<T[]>>

Before fetching posts, we need handle taxonomy and authors.

If the headless plugin is not being used, then additional requests needs to be made to get -authors and terms ids

Parameters

NameTypeDescription
urlstringThe URL to parse
paramsPartial<P>The params to build the endpoint with
optionsPartial<FetchOptions>FetchOptions

Returns

Promise<FetchResponse<T[]>>

Inherited from

PostsArchiveFetchStrategy.fetcher

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:393


filterData

filterData(data, options?): FetchResponse<T[]>

Filters the data returned from the API by excluding fields that are not needed in order to reduce -payload size.

Parameters

NameTypeDescription
dataFetchResponse<T[]>The data to filter
options?FilterDataOptions<T[]>Filter options

Returns

FetchResponse<T[]>

The filtered data

Inherited from

PostsArchiveFetchStrategy.filterData

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530


get

get(params?): Promise<FetchResponse<T[]>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters

NameTypeDescription
paramsPartial<P>The endpoint params

Returns

Promise<FetchResponse<T[]>>

Inherited from

PostsArchiveFetchStrategy.get

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:404


getAuthHeader

getAuthHeader(options?): string

Parameters

NameType
optionsPartial<FetchOptions>

Returns

string

Inherited from

PostsArchiveFetchStrategy.getAuthHeader

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:227


getCacheKey

getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters

NameTypeDescription
paramsPartial<P>The request params

Returns

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from

PostsArchiveFetchStrategy.getCacheKey

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:369


getDefaultEndpoint

getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint -for the strategy

Returns

string

Inherited from

PostsArchiveFetchStrategy.getDefaultEndpoint

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:214


getDefaultParams

getDefaultParams(): Partial<P>

Returns

Partial<P>

Inherited from

PostsArchiveFetchStrategy.getDefaultParams

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218


getEndpoint

getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, -returns the default endpoint

Returns

string

The current endpoint for the strategy

Inherited from

PostsArchiveFetchStrategy.getEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160


getParamsFromURL

getParamsFromURL(path, nonUrlParams?): Partial<P>

This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL

It also takes into account the custom taxonomies specified in headless.config.js

Parameters

NameTypeDescription
pathstringThe URL path to extract params from
nonUrlParamsPartial<P>

Returns

Partial<P>

Overrides

PostsArchiveFetchStrategy.getParamsFromURL

Defined in

packages/core/src/data/strategies/AuthorArchiveFetchStrategy.ts:20


getQueriedObject

getQueriedObject(response, params): QueriedObject

Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)

Parameters

NameTypeDescription
responseFetchResponse<T[]>The response from the API
paramsPartial<P>The request params

Returns

QueriedObject

Inherited from

PostsArchiveFetchStrategy.getQueriedObject

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461


isMainQuery

isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns

boolean

Inherited from

PostsArchiveFetchStrategy.isMainQuery

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:191


normalizeForCache

normalizeForCache(data, params): NormalizedDataForCache<T[], P>

Normalize data for cache.

Parameters

NameTypeDescription
dataFetchResponse<T[]>The fetch response data
paramsPartial<P>The request params

Returns

NormalizedDataForCache<T[], P>

Inherited from

PostsArchiveFetchStrategy.normalizeForCache

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:379


prepareResponse

prepareResponse(response, params): FetchResponse<T[]>

Parameters

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns

FetchResponse<T[]>

Inherited from

PostsArchiveFetchStrategy.prepareResponse

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327


setBaseURL

setBaseURL(url?): void

Parameters

NameTypeDefault value
urlundefined | string''

Returns

void

Inherited from

PostsArchiveFetchStrategy.setBaseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:150


setEndpoint

setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters

NameTypeDescription
endpointstringThe endpoint to fetch

Returns

void

Inherited from

PostsArchiveFetchStrategy.setEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:146

- +
Skip to main content

Class: AuthorArchiveFetchStrategy<T, P>

@headstartwp/core.AuthorArchiveFetchStrategy

The AuthorArchiveFetchStrategy extends the PostsArchiveFetchStrategy and performs author archive requests

This strategy supports extracting endpoint params from url E.g:

  • /author-name/ maps to { author: 'author-name' }
  • /author-name/page/2 maps to { author: 'author-name', page: 2 }

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Hierarchy

Constructors

constructor

new AuthorArchiveFetchStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from

PostsArchiveFetchStrategy.constructor

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

Properties

baseURL

baseURL: string = ''

The base URL where the API is located

Inherited from

PostsArchiveFetchStrategy.baseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:115


defaultParams

defaultParams: Partial<P> = {}

The Default Params

Inherited from

PostsArchiveFetchStrategy.defaultParams

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:105


endpoint

endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from

PostsArchiveFetchStrategy.endpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:110


locale

locale: string = ''

Inherited from

PostsArchiveFetchStrategy.locale

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212


path

path: string = ''

Inherited from

PostsArchiveFetchStrategy.path

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210

Methods

buildEndpointURL

buildEndpointURL(params): string

Handles taxonomy filters and switch endpoint based on post type

Parameters

NameTypeDescription
paramsPartial<P>The params to build the endpoint with

Returns

string

Inherited from

PostsArchiveFetchStrategy.buildEndpointURL

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289


fetcher

fetcher(url, params, options?): Promise<FetchResponse<T[]>>

Before fetching posts, we need handle taxonomy and authors.

If the headless plugin is not being used, then additional requests needs to be made to get +authors and terms ids

Parameters

NameTypeDescription
urlstringThe URL to parse
paramsPartial<P>The params to build the endpoint with
optionsPartial<FetchOptions>FetchOptions

Returns

Promise<FetchResponse<T[]>>

Inherited from

PostsArchiveFetchStrategy.fetcher

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:393


filterData

filterData(data, options?): FetchResponse<T[]>

Filters the data returned from the API by excluding fields that are not needed in order to reduce +payload size.

Parameters

NameTypeDescription
dataFetchResponse<T[]>The data to filter
options?FilterDataOptions<T[]>Filter options

Returns

FetchResponse<T[]>

The filtered data

Inherited from

PostsArchiveFetchStrategy.filterData

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530


get

get(params?): Promise<FetchResponse<T[]>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters

NameTypeDescription
paramsPartial<P>The endpoint params

Returns

Promise<FetchResponse<T[]>>

Inherited from

PostsArchiveFetchStrategy.get

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:404


getAuthHeader

getAuthHeader(options?): string

Parameters

NameType
optionsPartial<FetchOptions>

Returns

string

Inherited from

PostsArchiveFetchStrategy.getAuthHeader

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:227


getCacheKey

getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters

NameTypeDescription
paramsPartial<P>The request params

Returns

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from

PostsArchiveFetchStrategy.getCacheKey

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:369


getDefaultEndpoint

getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint +for the strategy

Returns

string

Inherited from

PostsArchiveFetchStrategy.getDefaultEndpoint

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:214


getDefaultParams

getDefaultParams(): Partial<P>

Returns

Partial<P>

Inherited from

PostsArchiveFetchStrategy.getDefaultParams

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218


getEndpoint

getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, +returns the default endpoint

Returns

string

The current endpoint for the strategy

Inherited from

PostsArchiveFetchStrategy.getEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160


getParamsFromURL

getParamsFromURL(path, nonUrlParams?): Partial<P>

This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL

It also takes into account the custom taxonomies specified in headless.config.js

Parameters

NameTypeDescription
pathstringThe URL path to extract params from
nonUrlParamsPartial<P>

Returns

Partial<P>

Overrides

PostsArchiveFetchStrategy.getParamsFromURL

Defined in

packages/core/src/data/strategies/AuthorArchiveFetchStrategy.ts:20


getQueriedObject

getQueriedObject(response, params): QueriedObject

Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)

Parameters

NameTypeDescription
responseFetchResponse<T[]>The response from the API
paramsPartial<P>The request params

Returns

QueriedObject

Inherited from

PostsArchiveFetchStrategy.getQueriedObject

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461


isMainQuery

isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns

boolean

Inherited from

PostsArchiveFetchStrategy.isMainQuery

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:191


normalizeForCache

normalizeForCache(data, params): NormalizedDataForCache<T[], P>

Normalize data for cache.

Parameters

NameTypeDescription
dataFetchResponse<T[]>The fetch response data
paramsPartial<P>The request params

Returns

NormalizedDataForCache<T[], P>

Inherited from

PostsArchiveFetchStrategy.normalizeForCache

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:379


prepareResponse

prepareResponse(response, params): FetchResponse<T[]>

Parameters

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns

FetchResponse<T[]>

Inherited from

PostsArchiveFetchStrategy.prepareResponse

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327


setBaseURL

setBaseURL(url?): void

Parameters

NameTypeDefault value
urlundefined | string''

Returns

void

Inherited from

PostsArchiveFetchStrategy.setBaseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:150


setEndpoint

setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters

NameTypeDescription
endpointstringThe endpoint to fetch

Returns

void

Inherited from

PostsArchiveFetchStrategy.setEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:146

+ \ No newline at end of file diff --git a/api/classes/headstartwp_core.Comment/index.html b/api/classes/headstartwp_core.Comment/index.html index c7ff4e257..9d8d0acf5 100644 --- a/api/classes/headstartwp_core.Comment/index.html +++ b/api/classes/headstartwp_core.Comment/index.html @@ -7,7 +7,7 @@ - + @@ -17,7 +17,7 @@ DOM spec-compatible alias.

Returns

string

Inherited from

DataNode.nodeValue

Defined in

node_modules/domhandler/lib/node.d.ts:90

set nodeValue(data): void

Parameters

NameType
datastring

Returns

void

Inherited from

DataNode.nodeValue

Defined in

node_modules/domhandler/lib/node.d.ts:91


parentNode

get parentNode(): null | ParentNode

Same as parent. DOM spec-compatible alias.

Returns

null | ParentNode

Inherited from

DataNode.parentNode

Defined in

node_modules/domhandler/lib/node.d.ts:55

set parentNode(parent): void

Parameters

NameType
parentnull | ParentNode

Returns

void

Inherited from

DataNode.parentNode

Defined in

node_modules/domhandler/lib/node.d.ts:56


previousSibling

get previousSibling(): null | ChildNode

Same as prev. DOM spec-compatible alias.

Returns

null | ChildNode

Inherited from

DataNode.previousSibling

Defined in

node_modules/domhandler/lib/node.d.ts:61

set previousSibling(prev): void

Parameters

NameType
prevnull | ChildNode

Returns

void

Inherited from

DataNode.previousSibling

Defined in

node_modules/domhandler/lib/node.d.ts:62

Methods

cloneNode

cloneNode<T>(this, recursive?): T

Clone this node, and optionally its children.

Type parameters

NameType
Textends Node<T>

Parameters

NameTypeDescription
thisT-
recursive?booleanClone child nodes as well.

Returns

T

A clone of the node.

Inherited from

DataNode.cloneNode

Defined in

node_modules/domhandler/lib/node.d.ts:75

- + \ No newline at end of file diff --git a/api/classes/headstartwp_core.ConfigError/index.html b/api/classes/headstartwp_core.ConfigError/index.html index 12460e1a4..5f33f2b5c 100644 --- a/api/classes/headstartwp_core.ConfigError/index.html +++ b/api/classes/headstartwp_core.ConfigError/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Class: ConfigError

@headstartwp/core.ConfigError

Hierarchy

  • Error

    ConfigError

Constructors

constructor

new ConfigError(message)

Parameters

NameType
messagestring

Overrides

Error.constructor

Defined in

packages/core/src/utils/errors.ts:18

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26


message

message: string

Inherited from

Error.message

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1054


name

name: string

Inherited from

Error.name

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1053


stack

Optional stack: string

Inherited from

Error.stack

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1055

node_modules/@types/node/globals.d.ts:127


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:140


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:142

Methods

captureStackTrace

Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectObject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:133

- +
Skip to main content

Class: ConfigError

@headstartwp/core.ConfigError

Hierarchy

  • Error

    ConfigError

Constructors

constructor

new ConfigError(message)

Parameters

NameType
messagestring

Overrides

Error.constructor

Defined in

packages/core/src/utils/errors.ts:18

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26


message

message: string

Inherited from

Error.message

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1054


name

name: string

Inherited from

Error.name

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1053


stack

Optional stack: string

Inherited from

Error.stack

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1055

node_modules/@types/node/globals.d.ts:127


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:140


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:142

Methods

captureStackTrace

Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectObject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:133

+ \ No newline at end of file diff --git a/api/classes/headstartwp_core.Element/index.html b/api/classes/headstartwp_core.Element/index.html index 145ff69c5..199fd16aa 100644 --- a/api/classes/headstartwp_core.Element/index.html +++ b/api/classes/headstartwp_core.Element/index.html @@ -7,7 +7,7 @@ - + @@ -18,7 +18,7 @@ DOM spec-compatible alias.

Returns

null | ParentNode

Inherited from

NodeWithChildren.parentNode

Defined in

node_modules/domhandler/lib/node.d.ts:55

set parentNode(parent): void

Parameters

NameType
parentnull | ParentNode

Returns

void

Inherited from

NodeWithChildren.parentNode

Defined in

node_modules/domhandler/lib/node.d.ts:56


previousSibling

get previousSibling(): null | ChildNode

Same as prev. DOM spec-compatible alias.

Returns

null | ChildNode

Inherited from

NodeWithChildren.previousSibling

Defined in

node_modules/domhandler/lib/node.d.ts:61

set previousSibling(prev): void

Parameters

NameType
prevnull | ChildNode

Returns

void

Inherited from

NodeWithChildren.previousSibling

Defined in

node_modules/domhandler/lib/node.d.ts:62


tagName

get tagName(): string

Same as name. DOM spec-compatible alias.

Returns

string

Defined in

node_modules/domhandler/lib/node.d.ts:192

set tagName(name): void

Parameters

NameType
namestring

Returns

void

Defined in

node_modules/domhandler/lib/node.d.ts:193

Methods

cloneNode

cloneNode<T>(this, recursive?): T

Clone this node, and optionally its children.

Type parameters

NameType
Textends Node<T>

Parameters

NameTypeDescription
thisT-
recursive?booleanClone child nodes as well.

Returns

T

A clone of the node.

Inherited from

NodeWithChildren.cloneNode

Defined in

node_modules/domhandler/lib/node.d.ts:75

- + \ No newline at end of file diff --git a/api/classes/headstartwp_core.EndpointError/index.html b/api/classes/headstartwp_core.EndpointError/index.html index df2414a55..b7f9d22f6 100644 --- a/api/classes/headstartwp_core.EndpointError/index.html +++ b/api/classes/headstartwp_core.EndpointError/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Class: EndpointError

@headstartwp/core.EndpointError

Hierarchy

  • Error

    EndpointError

Constructors

constructor

new EndpointError(message)

Parameters

NameType
messagestring

Overrides

Error.constructor

Defined in

packages/core/src/utils/errors.ts:25

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26


message

message: string

Inherited from

Error.message

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1054


name

name: string

Inherited from

Error.name

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1053


stack

Optional stack: string

Inherited from

Error.stack

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1055

node_modules/@types/node/globals.d.ts:127


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:140


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:142

Methods

captureStackTrace

Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectObject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:133

- +
Skip to main content

Class: EndpointError

@headstartwp/core.EndpointError

Hierarchy

  • Error

    EndpointError

Constructors

constructor

new EndpointError(message)

Parameters

NameType
messagestring

Overrides

Error.constructor

Defined in

packages/core/src/utils/errors.ts:25

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26


message

message: string

Inherited from

Error.message

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1054


name

name: string

Inherited from

Error.name

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1053


stack

Optional stack: string

Inherited from

Error.stack

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1055

node_modules/@types/node/globals.d.ts:127


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:140


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:142

Methods

captureStackTrace

Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectObject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:133

+ \ No newline at end of file diff --git a/api/classes/headstartwp_core.FetchError/index.html b/api/classes/headstartwp_core.FetchError/index.html index 4ecc2c0bf..42e3f879b 100644 --- a/api/classes/headstartwp_core.FetchError/index.html +++ b/api/classes/headstartwp_core.FetchError/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Class: FetchError

@headstartwp/core.FetchError

Hierarchy

  • Error

    FetchError

Constructors

constructor

new FetchError(message)

Parameters

NameType
messagestring

Overrides

Error.constructor

Defined in

packages/core/src/utils/errors.ts:11

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26


message

message: string

Inherited from

Error.message

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1054


name

name: string

Inherited from

Error.name

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1053


stack

Optional stack: string

Inherited from

Error.stack

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1055

node_modules/@types/node/globals.d.ts:127


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:140


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:142

Methods

captureStackTrace

Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectObject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:133

- +
Skip to main content

Class: FetchError

@headstartwp/core.FetchError

Hierarchy

  • Error

    FetchError

Constructors

constructor

new FetchError(message)

Parameters

NameType
messagestring

Overrides

Error.constructor

Defined in

packages/core/src/utils/errors.ts:11

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26


message

message: string

Inherited from

Error.message

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1054


name

name: string

Inherited from

Error.name

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1053


stack

Optional stack: string

Inherited from

Error.stack

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1055

node_modules/@types/node/globals.d.ts:127


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:140


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:142

Methods

captureStackTrace

Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectObject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:133

+ \ No newline at end of file diff --git a/api/classes/headstartwp_core.FrameworkError/index.html b/api/classes/headstartwp_core.FrameworkError/index.html index 340c59d8e..9276ce915 100644 --- a/api/classes/headstartwp_core.FrameworkError/index.html +++ b/api/classes/headstartwp_core.FrameworkError/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Class: FrameworkError

@headstartwp/core.FrameworkError

Hierarchy

  • Error

    FrameworkError

Constructors

constructor

new FrameworkError(message)

Parameters

NameType
messagestring

Overrides

Error.constructor

Defined in

packages/core/src/utils/errors.ts:32

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26


message

message: string

Inherited from

Error.message

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1054


name

name: string

Inherited from

Error.name

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1053


stack

Optional stack: string

Inherited from

Error.stack

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1055

node_modules/@types/node/globals.d.ts:127


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:140


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:142

Methods

captureStackTrace

Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectObject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:133

- +
Skip to main content

Class: FrameworkError

@headstartwp/core.FrameworkError

Hierarchy

  • Error

    FrameworkError

Constructors

constructor

new FrameworkError(message)

Parameters

NameType
messagestring

Overrides

Error.constructor

Defined in

packages/core/src/utils/errors.ts:32

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26


message

message: string

Inherited from

Error.message

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1054


name

name: string

Inherited from

Error.name

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1053


stack

Optional stack: string

Inherited from

Error.stack

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1055

node_modules/@types/node/globals.d.ts:127


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:140


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:142

Methods

captureStackTrace

Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectObject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:133

+ \ No newline at end of file diff --git a/api/classes/headstartwp_core.NotFoundError/index.html b/api/classes/headstartwp_core.NotFoundError/index.html index 39377d9cd..2e99a84e7 100644 --- a/api/classes/headstartwp_core.NotFoundError/index.html +++ b/api/classes/headstartwp_core.NotFoundError/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Class: NotFoundError

@headstartwp/core.NotFoundError

Hierarchy

  • Error

    NotFoundError

Constructors

constructor

new NotFoundError(message)

Parameters

NameType
messagestring

Overrides

Error.constructor

Defined in

packages/core/src/utils/errors.ts:4

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26


message

message: string

Inherited from

Error.message

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1054


name

name: string

Inherited from

Error.name

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1053


stack

Optional stack: string

Inherited from

Error.stack

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1055

node_modules/@types/node/globals.d.ts:127


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:140


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:142

Methods

captureStackTrace

Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectObject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:133

- +
Skip to main content

Class: NotFoundError

@headstartwp/core.NotFoundError

Hierarchy

  • Error

    NotFoundError

Constructors

constructor

new NotFoundError(message)

Parameters

NameType
messagestring

Overrides

Error.constructor

Defined in

packages/core/src/utils/errors.ts:4

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26


message

message: string

Inherited from

Error.message

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1054


name

name: string

Inherited from

Error.name

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1053


stack

Optional stack: string

Inherited from

Error.stack

Defined in

docs/node_modules/typescript/lib/lib.es5.d.ts:1055

node_modules/@types/node/globals.d.ts:127


prepareStackTrace

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:140


stackTraceLimit

Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:142

Methods

captureStackTrace

Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectObject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:133

+ \ No newline at end of file diff --git a/api/classes/headstartwp_core.PostOrPostsFetchStrategy/index.html b/api/classes/headstartwp_core.PostOrPostsFetchStrategy/index.html index b22ac1f8e..6215b68db 100644 --- a/api/classes/headstartwp_core.PostOrPostsFetchStrategy/index.html +++ b/api/classes/headstartwp_core.PostOrPostsFetchStrategy/index.html @@ -7,17 +7,17 @@ - +
-
Skip to main content

Class: PostOrPostsFetchStrategy<T, P, R>

@headstartwp/core.PostOrPostsFetchStrategy

This fetch strategy does not support extracting url params from the url

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostOrPostsParams = PostOrPostsParams
Rextends PostOrPostsFetchStrategyResult<T> = PostOrPostsFetchStrategyResult<T>

Hierarchy

Constructors

constructor

new PostOrPostsFetchStrategy<T, P, R>(baseURL?, defaultParams?)

The strategy constructor

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostOrPostsParams = PostOrPostsParams
Rextends PostOrPostsFetchStrategyResult<T> = PostOrPostsFetchStrategyResult<T>

Parameters

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from

AbstractFetchStrategy.constructor

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

Properties

baseURL

baseURL: string = ''

The base URL where the API is located

Inherited from

AbstractFetchStrategy.baseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:115


defaultParams

defaultParams: Partial<P> = {}

The Default Params

Inherited from

AbstractFetchStrategy.defaultParams

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:105


endpoint

endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from

AbstractFetchStrategy.endpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:110


postStrategy

postStrategy: SinglePostFetchStrategy<PostEntity, PostParams>

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:60


postsStrategy

postsStrategy: PostsArchiveFetchStrategy<PostEntity, PostsArchiveParams>

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:62


urlParams

urlParams: Partial<P> = {}

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:58

Methods

buildEndpointURL

buildEndpointURL(params): string

Builds the final endpoint URL based on the passed parameters

Parameters

NameTypeDescription
paramsPartial<P>The params to add to the request

Returns

string

The endpoint URL.

Inherited from

AbstractFetchStrategy.buildEndpointURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:206


fetchArchive

fetchArchive(url, params, options?): Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: R }>

Parameters

NameType
urlstring
paramsPostsArchiveParams
options?Partial<FetchOptions>

Returns

Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: R }>

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:145


fetchSingle

fetchSingle(url, params, options?): Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: R }>

Parameters

NameType
urlstring
paramsPostParams
options?Partial<FetchOptions>

Returns

Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: R }>

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:132


fetcher

fetcher(url, params, options?): Promise<FetchResponse<R>>

The default fetcher function

The default fetcher function handles authentication headers and errors from the API.

A custom strategy can override this function to run additional logic before or after the fetch call

Parameters

NameTypeDescription
urlstringThe URL to fetch
paramsPartial<P>The request params
options?Partial<FetchOptions>The fetcher options

Returns

Promise<FetchResponse<R>>

Overrides

AbstractFetchStrategy.fetcher

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:158


filterData

filterData(data, filterOptions?): FetchResponse<R>

Filters the data returned from the API by excluding fields that are not needed in order to reduce -payload size.

Parameters

NameTypeDescription
dataFetchResponse<R>The data to filter
filterOptions?FilterDataOptions<R>Filter options

Returns

FetchResponse<R>

The filtered data

Inherited from

AbstractFetchStrategy.filterData

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:339


get

get(params?): Promise<FetchResponse<R>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters

NameTypeDescription
paramsPartial<P>The endpoint params

Returns

Promise<FetchResponse<R>>

Inherited from

AbstractFetchStrategy.get

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:404


getAuthHeader

getAuthHeader(options?): string

Parameters

NameType
optionsPartial<FetchOptions>

Returns

string

Inherited from

AbstractFetchStrategy.getAuthHeader

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:227


getCacheKey

getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters

NameTypeDescription
paramsPartial<P>The request params

Returns

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from

AbstractFetchStrategy.getCacheKey

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:369


getDefaultEndpoint

getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint -for the strategy

Returns

string

Overrides

AbstractFetchStrategy.getDefaultEndpoint

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:64


getDefaultParams

getDefaultParams(): Partial<P>

Returns

Partial<P>

Inherited from

AbstractFetchStrategy.getDefaultParams

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:168


getEndpoint

getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, -returns the default endpoint

Returns

string

The current endpoint for the strategy

Inherited from

AbstractFetchStrategy.getEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160


getParamsFromURL

getParamsFromURL(path, params?): Partial<P>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support -mapping url params to endpoint params, it should return an empty object.

Parameters

NameTypeDescription
pathstringThe Path name
paramsPartial<P>The non-url params

Returns

Partial<P>

params extracted from the URL

Overrides

AbstractFetchStrategy.getParamsFromURL

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:68


getQueriedObject

getQueriedObject(response, params): Object

Parameters

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns

Object

Inherited from

AbstractFetchStrategy.getQueriedObject

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:327


isMainQuery

isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns

boolean

Inherited from

AbstractFetchStrategy.isMainQuery

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:191


normalizeForCache

normalizeForCache(data, params): NormalizedDataForCache<R, P>

Normalize data for cache.

Parameters

NameTypeDescription
dataFetchResponse<R>The fetch response data
paramsPartial<P>The request params

Returns

NormalizedDataForCache<R, P>

Overrides

AbstractFetchStrategy.normalizeForCache

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:77


prepareResponse

prepareResponse(response, params): FetchResponse<R>

Parameters

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns

FetchResponse<R>

Inherited from

AbstractFetchStrategy.prepareResponse

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:219


setBaseURL

setBaseURL(url?): void

Parameters

NameTypeDefault value
urlundefined | string''

Returns

void

Inherited from

AbstractFetchStrategy.setBaseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:150


setEndpoint

setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters

NameTypeDescription
endpointstringThe endpoint to fetch

Returns

void

Inherited from

AbstractFetchStrategy.setEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:146

- +
Skip to main content

Class: PostOrPostsFetchStrategy<T, P, R>

@headstartwp/core.PostOrPostsFetchStrategy

This fetch strategy does not support extracting url params from the url

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostOrPostsParams = PostOrPostsParams
Rextends PostOrPostsFetchStrategyResult<T> = PostOrPostsFetchStrategyResult<T>

Hierarchy

Constructors

constructor

new PostOrPostsFetchStrategy<T, P, R>(baseURL?, defaultParams?)

The strategy constructor

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostOrPostsParams = PostOrPostsParams
Rextends PostOrPostsFetchStrategyResult<T> = PostOrPostsFetchStrategyResult<T>

Parameters

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from

AbstractFetchStrategy.constructor

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

Properties

baseURL

baseURL: string = ''

The base URL where the API is located

Inherited from

AbstractFetchStrategy.baseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:115


defaultParams

defaultParams: Partial<P> = {}

The Default Params

Inherited from

AbstractFetchStrategy.defaultParams

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:105


endpoint

endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from

AbstractFetchStrategy.endpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:110


postStrategy

postStrategy: SinglePostFetchStrategy<PostEntity, PostParams>

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:60


postsStrategy

postsStrategy: PostsArchiveFetchStrategy<PostEntity, PostsArchiveParams>

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:62


urlParams

urlParams: Partial<P> = {}

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:58

Methods

buildEndpointURL

buildEndpointURL(params): string

Builds the final endpoint URL based on the passed parameters

Parameters

NameTypeDescription
paramsPartial<P>The params to add to the request

Returns

string

The endpoint URL.

Inherited from

AbstractFetchStrategy.buildEndpointURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:206


fetchArchive

fetchArchive(url, params, options?): Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: R }>

Parameters

NameType
urlstring
paramsPostsArchiveParams
options?Partial<FetchOptions>

Returns

Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: R }>

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:145


fetchSingle

fetchSingle(url, params, options?): Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: R }>

Parameters

NameType
urlstring
paramsPostParams
options?Partial<FetchOptions>

Returns

Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: R }>

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:132


fetcher

fetcher(url, params, options?): Promise<FetchResponse<R>>

The default fetcher function

The default fetcher function handles authentication headers and errors from the API.

A custom strategy can override this function to run additional logic before or after the fetch call

Parameters

NameTypeDescription
urlstringThe URL to fetch
paramsPartial<P>The request params
options?Partial<FetchOptions>The fetcher options

Returns

Promise<FetchResponse<R>>

Overrides

AbstractFetchStrategy.fetcher

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:158


filterData

filterData(data, filterOptions?): FetchResponse<R>

Filters the data returned from the API by excluding fields that are not needed in order to reduce +payload size.

Parameters

NameTypeDescription
dataFetchResponse<R>The data to filter
filterOptions?FilterDataOptions<R>Filter options

Returns

FetchResponse<R>

The filtered data

Inherited from

AbstractFetchStrategy.filterData

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:339


get

get(params?): Promise<FetchResponse<R>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters

NameTypeDescription
paramsPartial<P>The endpoint params

Returns

Promise<FetchResponse<R>>

Inherited from

AbstractFetchStrategy.get

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:404


getAuthHeader

getAuthHeader(options?): string

Parameters

NameType
optionsPartial<FetchOptions>

Returns

string

Inherited from

AbstractFetchStrategy.getAuthHeader

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:227


getCacheKey

getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters

NameTypeDescription
paramsPartial<P>The request params

Returns

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from

AbstractFetchStrategy.getCacheKey

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:369


getDefaultEndpoint

getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint +for the strategy

Returns

string

Overrides

AbstractFetchStrategy.getDefaultEndpoint

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:64


getDefaultParams

getDefaultParams(): Partial<P>

Returns

Partial<P>

Inherited from

AbstractFetchStrategy.getDefaultParams

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:168


getEndpoint

getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, +returns the default endpoint

Returns

string

The current endpoint for the strategy

Inherited from

AbstractFetchStrategy.getEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160


getParamsFromURL

getParamsFromURL(path, params?): Partial<P>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support +mapping url params to endpoint params, it should return an empty object.

Parameters

NameTypeDescription
pathstringThe Path name
paramsPartial<P>The non-url params

Returns

Partial<P>

params extracted from the URL

Overrides

AbstractFetchStrategy.getParamsFromURL

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:68


getQueriedObject

getQueriedObject(response, params): Object

Parameters

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns

Object

Inherited from

AbstractFetchStrategy.getQueriedObject

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:327


isMainQuery

isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns

boolean

Inherited from

AbstractFetchStrategy.isMainQuery

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:191


normalizeForCache

normalizeForCache(data, params): NormalizedDataForCache<R, P>

Normalize data for cache.

Parameters

NameTypeDescription
dataFetchResponse<R>The fetch response data
paramsPartial<P>The request params

Returns

NormalizedDataForCache<R, P>

Overrides

AbstractFetchStrategy.normalizeForCache

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:77


prepareResponse

prepareResponse(response, params): FetchResponse<R>

Parameters

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns

FetchResponse<R>

Inherited from

AbstractFetchStrategy.prepareResponse

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:219


setBaseURL

setBaseURL(url?): void

Parameters

NameTypeDefault value
urlundefined | string''

Returns

void

Inherited from

AbstractFetchStrategy.setBaseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:150


setEndpoint

setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters

NameTypeDescription
endpointstringThe endpoint to fetch

Returns

void

Inherited from

AbstractFetchStrategy.setEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:146

+ \ No newline at end of file diff --git a/api/classes/headstartwp_core.PostsArchiveFetchStrategy/index.html b/api/classes/headstartwp_core.PostsArchiveFetchStrategy/index.html index 64767dabb..2bf04ee9e 100644 --- a/api/classes/headstartwp_core.PostsArchiveFetchStrategy/index.html +++ b/api/classes/headstartwp_core.PostsArchiveFetchStrategy/index.html @@ -7,18 +7,18 @@ - +
Skip to main content

Class: PostsArchiveFetchStrategy<T, P>

@headstartwp/core.PostsArchiveFetchStrategy

The PostsArchiveFetchStrategy is used to fetch a collection of posts from any post type. -Note that custom post types and custom taxonomies should be defined in headless.config.js

This strategy supports extracting endpoint params from url E.g:

  • /category/cat-name/page/2 maps to { category: 'cat-name', page: 2 }
  • /page/2/ maps to { page: 2 }
  • /genre/genre-name/page/2 maps to { genre: 'genre-name', page: 2 } if a genre taxonomy is defined in headless.config.js

See

getParamsFromURL to learn about url param mapping

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Hierarchy

Constructors

constructor

new PostsArchiveFetchStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from

AbstractFetchStrategy.constructor

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

Properties

baseURL

baseURL: string = ''

The base URL where the API is located

Inherited from

AbstractFetchStrategy.baseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:115


defaultParams

defaultParams: Partial<P> = {}

The Default Params

Inherited from

AbstractFetchStrategy.defaultParams

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:105


endpoint

endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from

AbstractFetchStrategy.endpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:110


locale

locale: string = ''

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212


path

path: string = ''

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210

Methods

buildEndpointURL

buildEndpointURL(params): string

Handles taxonomy filters and switch endpoint based on post type

Parameters

NameTypeDescription
paramsPartial<P>The params to build the endpoint with

Returns

string

Overrides

AbstractFetchStrategy.buildEndpointURL

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289


fetcher

fetcher(url, params, options?): Promise<FetchResponse<T[]>>

Before fetching posts, we need handle taxonomy and authors.

If the headless plugin is not being used, then additional requests needs to be made to get -authors and terms ids

Parameters

NameTypeDescription
urlstringThe URL to parse
paramsPartial<P>The params to build the endpoint with
optionsPartial<FetchOptions>FetchOptions

Returns

Promise<FetchResponse<T[]>>

Overrides

AbstractFetchStrategy.fetcher

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:393


filterData

filterData(data, options?): FetchResponse<T[]>

Filters the data returned from the API by excluding fields that are not needed in order to reduce -payload size.

Parameters

NameTypeDescription
dataFetchResponse<T[]>The data to filter
options?FilterDataOptions<T[]>Filter options

Returns

FetchResponse<T[]>

The filtered data

Overrides

AbstractFetchStrategy.filterData

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530


get

get(params?): Promise<FetchResponse<T[]>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters

NameTypeDescription
paramsPartial<P>The endpoint params

Returns

Promise<FetchResponse<T[]>>

Inherited from

AbstractFetchStrategy.get

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:404


getAuthHeader

getAuthHeader(options?): string

Parameters

NameType
optionsPartial<FetchOptions>

Returns

string

Inherited from

AbstractFetchStrategy.getAuthHeader

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:227


getCacheKey

getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters

NameTypeDescription
paramsPartial<P>The request params

Returns

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from

AbstractFetchStrategy.getCacheKey

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:369


getDefaultEndpoint

getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint -for the strategy

Returns

string

Overrides

AbstractFetchStrategy.getDefaultEndpoint

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:214


getDefaultParams

getDefaultParams(): Partial<P>

Returns

Partial<P>

Overrides

AbstractFetchStrategy.getDefaultParams

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218


getEndpoint

getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, -returns the default endpoint

Returns

string

The current endpoint for the strategy

Inherited from

AbstractFetchStrategy.getEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160


getParamsFromURL

getParamsFromURL(path, params?): Partial<P>

This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL

It also takes into account the custom taxonomies specified in headless.config.js

Parameters

NameTypeDescription
pathstringThe URL path to extract params from
paramsPartial<P>

Returns

Partial<P>

Overrides

AbstractFetchStrategy.getParamsFromURL

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:230


getQueriedObject

getQueriedObject(response, params): QueriedObject

Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)

Parameters

NameTypeDescription
responseFetchResponse<T[]>The response from the API
paramsPartial<P>The request params

Returns

QueriedObject

Overrides

AbstractFetchStrategy.getQueriedObject

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461


isMainQuery

isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns

boolean

Inherited from

AbstractFetchStrategy.isMainQuery

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:191


normalizeForCache

normalizeForCache(data, params): NormalizedDataForCache<T[], P>

Normalize data for cache.

Parameters

NameTypeDescription
dataFetchResponse<T[]>The fetch response data
paramsPartial<P>The request params

Returns

NormalizedDataForCache<T[], P>

Inherited from

AbstractFetchStrategy.normalizeForCache

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:379


prepareResponse

prepareResponse(response, params): FetchResponse<T[]>

Parameters

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns

FetchResponse<T[]>

Overrides

AbstractFetchStrategy.prepareResponse

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327


setBaseURL

setBaseURL(url?): void

Parameters

NameTypeDefault value
urlundefined | string''

Returns

void

Inherited from

AbstractFetchStrategy.setBaseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:150


setEndpoint

setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters

NameTypeDescription
endpointstringThe endpoint to fetch

Returns

void

Inherited from

AbstractFetchStrategy.setEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:146

- +Note that custom post types and custom taxonomies should be defined in headless.config.js

This strategy supports extracting endpoint params from url E.g:

See

getParamsFromURL to learn about url param mapping

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Hierarchy

Constructors

constructor

new PostsArchiveFetchStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from

AbstractFetchStrategy.constructor

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

Properties

baseURL

baseURL: string = ''

The base URL where the API is located

Inherited from

AbstractFetchStrategy.baseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:115


defaultParams

defaultParams: Partial<P> = {}

The Default Params

Inherited from

AbstractFetchStrategy.defaultParams

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:105


endpoint

endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from

AbstractFetchStrategy.endpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:110


locale

locale: string = ''

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212


path

path: string = ''

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210

Methods

buildEndpointURL

buildEndpointURL(params): string

Handles taxonomy filters and switch endpoint based on post type

Parameters

NameTypeDescription
paramsPartial<P>The params to build the endpoint with

Returns

string

Overrides

AbstractFetchStrategy.buildEndpointURL

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289


fetcher

fetcher(url, params, options?): Promise<FetchResponse<T[]>>

Before fetching posts, we need handle taxonomy and authors.

If the headless plugin is not being used, then additional requests needs to be made to get +authors and terms ids

Parameters

NameTypeDescription
urlstringThe URL to parse
paramsPartial<P>The params to build the endpoint with
optionsPartial<FetchOptions>FetchOptions

Returns

Promise<FetchResponse<T[]>>

Overrides

AbstractFetchStrategy.fetcher

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:393


filterData

filterData(data, options?): FetchResponse<T[]>

Filters the data returned from the API by excluding fields that are not needed in order to reduce +payload size.

Parameters

NameTypeDescription
dataFetchResponse<T[]>The data to filter
options?FilterDataOptions<T[]>Filter options

Returns

FetchResponse<T[]>

The filtered data

Overrides

AbstractFetchStrategy.filterData

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530


get

get(params?): Promise<FetchResponse<T[]>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters

NameTypeDescription
paramsPartial<P>The endpoint params

Returns

Promise<FetchResponse<T[]>>

Inherited from

AbstractFetchStrategy.get

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:404


getAuthHeader

getAuthHeader(options?): string

Parameters

NameType
optionsPartial<FetchOptions>

Returns

string

Inherited from

AbstractFetchStrategy.getAuthHeader

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:227


getCacheKey

getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters

NameTypeDescription
paramsPartial<P>The request params

Returns

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from

AbstractFetchStrategy.getCacheKey

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:369


getDefaultEndpoint

getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint +for the strategy

Returns

string

Overrides

AbstractFetchStrategy.getDefaultEndpoint

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:214


getDefaultParams

getDefaultParams(): Partial<P>

Returns

Partial<P>

Overrides

AbstractFetchStrategy.getDefaultParams

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218


getEndpoint

getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, +returns the default endpoint

Returns

string

The current endpoint for the strategy

Inherited from

AbstractFetchStrategy.getEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160


getParamsFromURL

getParamsFromURL(path, params?): Partial<P>

This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL

It also takes into account the custom taxonomies specified in headless.config.js

Parameters

NameTypeDescription
pathstringThe URL path to extract params from
paramsPartial<P>

Returns

Partial<P>

Overrides

AbstractFetchStrategy.getParamsFromURL

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:230


getQueriedObject

getQueriedObject(response, params): QueriedObject

Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)

Parameters

NameTypeDescription
responseFetchResponse<T[]>The response from the API
paramsPartial<P>The request params

Returns

QueriedObject

Overrides

AbstractFetchStrategy.getQueriedObject

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461


isMainQuery

isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns

boolean

Inherited from

AbstractFetchStrategy.isMainQuery

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:191


normalizeForCache

normalizeForCache(data, params): NormalizedDataForCache<T[], P>

Normalize data for cache.

Parameters

NameTypeDescription
dataFetchResponse<T[]>The fetch response data
paramsPartial<P>The request params

Returns

NormalizedDataForCache<T[], P>

Inherited from

AbstractFetchStrategy.normalizeForCache

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:379


prepareResponse

prepareResponse(response, params): FetchResponse<T[]>

Parameters

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns

FetchResponse<T[]>

Overrides

AbstractFetchStrategy.prepareResponse

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327


setBaseURL

setBaseURL(url?): void

Parameters

NameTypeDefault value
urlundefined | string''

Returns

void

Inherited from

AbstractFetchStrategy.setBaseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:150


setEndpoint

setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters

NameTypeDescription
endpointstringThe endpoint to fetch

Returns

void

Inherited from

AbstractFetchStrategy.setEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:146

+ \ No newline at end of file diff --git a/api/classes/headstartwp_core.ProcessingInstruction/index.html b/api/classes/headstartwp_core.ProcessingInstruction/index.html index 50da84137..72a306767 100644 --- a/api/classes/headstartwp_core.ProcessingInstruction/index.html +++ b/api/classes/headstartwp_core.ProcessingInstruction/index.html @@ -7,7 +7,7 @@ - + @@ -17,7 +17,7 @@ DOM spec-compatible alias.

Returns

string

Inherited from

DataNode.nodeValue

Defined in

node_modules/domhandler/lib/node.d.ts:90

set nodeValue(data): void

Parameters

NameType
datastring

Returns

void

Inherited from

DataNode.nodeValue

Defined in

node_modules/domhandler/lib/node.d.ts:91


parentNode

get parentNode(): null | ParentNode

Same as parent. DOM spec-compatible alias.

Returns

null | ParentNode

Inherited from

DataNode.parentNode

Defined in

node_modules/domhandler/lib/node.d.ts:55

set parentNode(parent): void

Parameters

NameType
parentnull | ParentNode

Returns

void

Inherited from

DataNode.parentNode

Defined in

node_modules/domhandler/lib/node.d.ts:56


previousSibling

get previousSibling(): null | ChildNode

Same as prev. DOM spec-compatible alias.

Returns

null | ChildNode

Inherited from

DataNode.previousSibling

Defined in

node_modules/domhandler/lib/node.d.ts:61

set previousSibling(prev): void

Parameters

NameType
prevnull | ChildNode

Returns

void

Inherited from

DataNode.previousSibling

Defined in

node_modules/domhandler/lib/node.d.ts:62

Methods

cloneNode

cloneNode<T>(this, recursive?): T

Clone this node, and optionally its children.

Type parameters

NameType
Textends Node<T>

Parameters

NameTypeDescription
thisT-
recursive?booleanClone child nodes as well.

Returns

T

A clone of the node.

Inherited from

DataNode.cloneNode

Defined in

node_modules/domhandler/lib/node.d.ts:75

- + \ No newline at end of file diff --git a/api/classes/headstartwp_core.SearchFetchStrategy/index.html b/api/classes/headstartwp_core.SearchFetchStrategy/index.html index 926438abd..ed71b9021 100644 --- a/api/classes/headstartwp_core.SearchFetchStrategy/index.html +++ b/api/classes/headstartwp_core.SearchFetchStrategy/index.html @@ -7,18 +7,18 @@ - +
Skip to main content

Class: SearchFetchStrategy<T, P>

@headstartwp/core.SearchFetchStrategy

The SearchFetchStrategy extends the PostsArchiveFetchStrategy and does not make use of the -search endpoint. Instead it uses the specified postType endpoint.

This strategy supports extracting endpoint params from url E.g:

  • /page/2/ maps to { page: 2 }
  • /searched-term/page/2 maps to { search: 'searched-term', page: 2 }

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Hierarchy

Constructors

constructor

new SearchFetchStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from

PostsArchiveFetchStrategy.constructor

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

Properties

baseURL

baseURL: string = ''

The base URL where the API is located

Inherited from

PostsArchiveFetchStrategy.baseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:115


defaultParams

defaultParams: Partial<P> = {}

The Default Params

Inherited from

PostsArchiveFetchStrategy.defaultParams

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:105


endpoint

endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from

PostsArchiveFetchStrategy.endpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:110


locale

locale: string = ''

Inherited from

PostsArchiveFetchStrategy.locale

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212


path

path: string = ''

Inherited from

PostsArchiveFetchStrategy.path

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210

Methods

buildEndpointURL

buildEndpointURL(params): string

Handles taxonomy filters and switch endpoint based on post type

Parameters

NameTypeDescription
paramsPartial<P>The params to build the endpoint with

Returns

string

Inherited from

PostsArchiveFetchStrategy.buildEndpointURL

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289


fetcher

fetcher(url, params, options?): Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: T[] }>

The fetcher function is overridden to disable throwing if not found

If a search request returns not found we do not want to redirect to a 404 page, -instead the user should be informed that no posts were found

Parameters

NameTypeDescription
urlstringThe url to parse
paramsPartial<P>The params to build the endpoint with
optionsPartial<FetchOptions>FetchOptions

Returns

Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: T[] }>

Overrides

PostsArchiveFetchStrategy.fetcher

Defined in

packages/core/src/data/strategies/SearchFetchStrategy.ts:46


filterData

filterData(data, options?): FetchResponse<T[]>

Filters the data returned from the API by excluding fields that are not needed in order to reduce -payload size.

Parameters

NameTypeDescription
dataFetchResponse<T[]>The data to filter
options?FilterDataOptions<T[]>Filter options

Returns

FetchResponse<T[]>

The filtered data

Inherited from

PostsArchiveFetchStrategy.filterData

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530


get

get(params?): Promise<FetchResponse<T[]>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters

NameTypeDescription
paramsPartial<P>The endpoint params

Returns

Promise<FetchResponse<T[]>>

Inherited from

PostsArchiveFetchStrategy.get

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:404


getAuthHeader

getAuthHeader(options?): string

Parameters

NameType
optionsPartial<FetchOptions>

Returns

string

Inherited from

PostsArchiveFetchStrategy.getAuthHeader

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:227


getCacheKey

getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters

NameTypeDescription
paramsPartial<P>The request params

Returns

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from

PostsArchiveFetchStrategy.getCacheKey

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:369


getDefaultEndpoint

getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint -for the strategy

Returns

string

Overrides

PostsArchiveFetchStrategy.getDefaultEndpoint

Defined in

packages/core/src/data/strategies/SearchFetchStrategy.ts:24


getDefaultParams

getDefaultParams(): Partial<P>

Returns

Partial<P>

Inherited from

PostsArchiveFetchStrategy.getDefaultParams

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218


getEndpoint

getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, -returns the default endpoint

Returns

string

The current endpoint for the strategy

Inherited from

PostsArchiveFetchStrategy.getEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160


getParamsFromURL

getParamsFromURL(path, nonUrlParams?): Partial<P>

This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL

It also takes into account the custom taxonomies specified in headless.config.js

Parameters

NameTypeDescription
pathstringThe URL path to extract params from
nonUrlParamsPartial<P>

Returns

Partial<P>

Overrides

PostsArchiveFetchStrategy.getParamsFromURL

Defined in

packages/core/src/data/strategies/SearchFetchStrategy.ts:28


getQueriedObject

getQueriedObject(response, params): QueriedObject

Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)

Parameters

NameTypeDescription
responseFetchResponse<T[]>The response from the API
paramsPartial<P>The request params

Returns

QueriedObject

Inherited from

PostsArchiveFetchStrategy.getQueriedObject

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461


isMainQuery

isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns

boolean

Inherited from

PostsArchiveFetchStrategy.isMainQuery

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:191


normalizeForCache

normalizeForCache(data, params): NormalizedDataForCache<T[], P>

Normalize data for cache.

Parameters

NameTypeDescription
dataFetchResponse<T[]>The fetch response data
paramsPartial<P>The request params

Returns

NormalizedDataForCache<T[], P>

Inherited from

PostsArchiveFetchStrategy.normalizeForCache

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:379


prepareResponse

prepareResponse(response, params): FetchResponse<T[]>

Parameters

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns

FetchResponse<T[]>

Inherited from

PostsArchiveFetchStrategy.prepareResponse

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327


setBaseURL

setBaseURL(url?): void

Parameters

NameTypeDefault value
urlundefined | string''

Returns

void

Inherited from

PostsArchiveFetchStrategy.setBaseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:150


setEndpoint

setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters

NameTypeDescription
endpointstringThe endpoint to fetch

Returns

void

Inherited from

PostsArchiveFetchStrategy.setEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:146

- +search endpoint. Instead it uses the specified postType endpoint.

This strategy supports extracting endpoint params from url E.g:

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Hierarchy

Constructors

constructor

new SearchFetchStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from

PostsArchiveFetchStrategy.constructor

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

Properties

baseURL

baseURL: string = ''

The base URL where the API is located

Inherited from

PostsArchiveFetchStrategy.baseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:115


defaultParams

defaultParams: Partial<P> = {}

The Default Params

Inherited from

PostsArchiveFetchStrategy.defaultParams

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:105


endpoint

endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from

PostsArchiveFetchStrategy.endpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:110


locale

locale: string = ''

Inherited from

PostsArchiveFetchStrategy.locale

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212


path

path: string = ''

Inherited from

PostsArchiveFetchStrategy.path

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210

Methods

buildEndpointURL

buildEndpointURL(params): string

Handles taxonomy filters and switch endpoint based on post type

Parameters

NameTypeDescription
paramsPartial<P>The params to build the endpoint with

Returns

string

Inherited from

PostsArchiveFetchStrategy.buildEndpointURL

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289


fetcher

fetcher(url, params, options?): Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: T[] }>

The fetcher function is overridden to disable throwing if not found

If a search request returns not found we do not want to redirect to a 404 page, +instead the user should be informed that no posts were found

Parameters

NameTypeDescription
urlstringThe url to parse
paramsPartial<P>The params to build the endpoint with
optionsPartial<FetchOptions>FetchOptions

Returns

Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: T[] }>

Overrides

PostsArchiveFetchStrategy.fetcher

Defined in

packages/core/src/data/strategies/SearchFetchStrategy.ts:46


filterData

filterData(data, options?): FetchResponse<T[]>

Filters the data returned from the API by excluding fields that are not needed in order to reduce +payload size.

Parameters

NameTypeDescription
dataFetchResponse<T[]>The data to filter
options?FilterDataOptions<T[]>Filter options

Returns

FetchResponse<T[]>

The filtered data

Inherited from

PostsArchiveFetchStrategy.filterData

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530


get

get(params?): Promise<FetchResponse<T[]>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters

NameTypeDescription
paramsPartial<P>The endpoint params

Returns

Promise<FetchResponse<T[]>>

Inherited from

PostsArchiveFetchStrategy.get

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:404


getAuthHeader

getAuthHeader(options?): string

Parameters

NameType
optionsPartial<FetchOptions>

Returns

string

Inherited from

PostsArchiveFetchStrategy.getAuthHeader

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:227


getCacheKey

getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters

NameTypeDescription
paramsPartial<P>The request params

Returns

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from

PostsArchiveFetchStrategy.getCacheKey

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:369


getDefaultEndpoint

getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint +for the strategy

Returns

string

Overrides

PostsArchiveFetchStrategy.getDefaultEndpoint

Defined in

packages/core/src/data/strategies/SearchFetchStrategy.ts:24


getDefaultParams

getDefaultParams(): Partial<P>

Returns

Partial<P>

Inherited from

PostsArchiveFetchStrategy.getDefaultParams

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218


getEndpoint

getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, +returns the default endpoint

Returns

string

The current endpoint for the strategy

Inherited from

PostsArchiveFetchStrategy.getEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160


getParamsFromURL

getParamsFromURL(path, nonUrlParams?): Partial<P>

This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL

It also takes into account the custom taxonomies specified in headless.config.js

Parameters

NameTypeDescription
pathstringThe URL path to extract params from
nonUrlParamsPartial<P>

Returns

Partial<P>

Overrides

PostsArchiveFetchStrategy.getParamsFromURL

Defined in

packages/core/src/data/strategies/SearchFetchStrategy.ts:28


getQueriedObject

getQueriedObject(response, params): QueriedObject

Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)

Parameters

NameTypeDescription
responseFetchResponse<T[]>The response from the API
paramsPartial<P>The request params

Returns

QueriedObject

Inherited from

PostsArchiveFetchStrategy.getQueriedObject

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461


isMainQuery

isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns

boolean

Inherited from

PostsArchiveFetchStrategy.isMainQuery

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:191


normalizeForCache

normalizeForCache(data, params): NormalizedDataForCache<T[], P>

Normalize data for cache.

Parameters

NameTypeDescription
dataFetchResponse<T[]>The fetch response data
paramsPartial<P>The request params

Returns

NormalizedDataForCache<T[], P>

Inherited from

PostsArchiveFetchStrategy.normalizeForCache

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:379


prepareResponse

prepareResponse(response, params): FetchResponse<T[]>

Parameters

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns

FetchResponse<T[]>

Inherited from

PostsArchiveFetchStrategy.prepareResponse

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327


setBaseURL

setBaseURL(url?): void

Parameters

NameTypeDefault value
urlundefined | string''

Returns

void

Inherited from

PostsArchiveFetchStrategy.setBaseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:150


setEndpoint

setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters

NameTypeDescription
endpointstringThe endpoint to fetch

Returns

void

Inherited from

PostsArchiveFetchStrategy.setEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:146

+ \ No newline at end of file diff --git a/api/classes/headstartwp_core.SinglePostFetchStrategy/index.html b/api/classes/headstartwp_core.SinglePostFetchStrategy/index.html index 0fe8020c4..28285c2e0 100644 --- a/api/classes/headstartwp_core.SinglePostFetchStrategy/index.html +++ b/api/classes/headstartwp_core.SinglePostFetchStrategy/index.html @@ -7,18 +7,18 @@ - +
Skip to main content

Class: SinglePostFetchStrategy<T, P>

@headstartwp/core.SinglePostFetchStrategy

The SinglePostFetchStrategy is used to fetch a single post entity from any post type. -Note that custom post types should be defined in headless.config.js

This strategy supports extracting endpoint params from url E.g:

  • /post-name maps to { slug: 'post-name'}
  • /2021/10/20/post-name maps to { year: 2021, month: 10, day: 20, slug: 'post-name }
  • /2021/ maps to { year: 2021, slug: 'post-name' }

See

getParamsFromURL to learn about url param mapping

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostParams = PostParams

Hierarchy

Constructors

constructor

new SinglePostFetchStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostParams = PostParams

Parameters

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from

AbstractFetchStrategy.constructor

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

Properties

baseURL

baseURL: string = ''

The base URL where the API is located

Inherited from

AbstractFetchStrategy.baseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:115


defaultParams

defaultParams: Partial<P> = {}

The Default Params

Inherited from

AbstractFetchStrategy.defaultParams

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:105


endpoint

endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from

AbstractFetchStrategy.endpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:110


locale

locale: string = ''

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:89


path

path: string = ''

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:87


postType

postType: string = 'post'

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:83


revision

Optional revision: PostEntity

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:85


shouldCheckCurrentPathAgainstPostLink: boolean = true

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:91

Methods

buildEndpointURL

buildEndpointURL(params): string

Handlers post types, revisions and fetching by id

Parameters

NameTypeDescription
paramsPThe params to build the endpoint url

Returns

string

Overrides

AbstractFetchStrategy.buildEndpointURL

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:127


fetcher

fetcher(url, params, options?): Promise<FetchResponse<T>>

Handles fetching by multiple post types, authToken and revisions

Parameters

NameTypeDescription
urlstringThe url to fetch
paramsPThe params to build the endpoint url
optionsPartial<FetchOptions>FetchOptions

Returns

Promise<FetchResponse<T>>

Overrides

AbstractFetchStrategy.fetcher

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:275


filterData

filterData(data, filterOptions?): any

Filters the data returned from the API by excluding fields that are not needed in order to reduce -payload size.

Parameters

NameTypeDescription
dataFetchResponse<PostEntity>The data to filter
filterOptions?FilterDataOptions<PostEntity>Filter options

Returns

any

The filtered data

Overrides

AbstractFetchStrategy.filterData

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:338


get

get(params?): Promise<FetchResponse<T>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters

NameTypeDescription
paramsPartial<P>The endpoint params

Returns

Promise<FetchResponse<T>>

Inherited from

AbstractFetchStrategy.get

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:404


getAuthHeader

getAuthHeader(options?): string

Parameters

NameType
optionsPartial<FetchOptions>

Returns

string

Inherited from

AbstractFetchStrategy.getAuthHeader

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:227


getCacheKey

getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters

NameTypeDescription
paramsPartial<P>The request params

Returns

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from

AbstractFetchStrategy.getCacheKey

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:369


getDefaultEndpoint

getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint -for the strategy

Returns

string

Overrides

AbstractFetchStrategy.getDefaultEndpoint

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:93


getDefaultParams

getDefaultParams(): Partial<P>

Returns

Partial<P>

Overrides

AbstractFetchStrategy.getDefaultParams

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:97


getEndpoint

getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, -returns the default endpoint

Returns

string

The current endpoint for the strategy

Inherited from

AbstractFetchStrategy.getEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160


getParamsFromURL

getParamsFromURL(path, nonUrlParams?): Partial<P>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support -mapping url params to endpoint params, it should return an empty object.

Parameters

NameTypeDescription
pathstringThe Path name
nonUrlParamsPartial<P>The non-url params

Returns

Partial<P>

params extracted from the URL

Overrides

AbstractFetchStrategy.getParamsFromURL

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:102


getPostThatMatchesCurrentPath

getPostThatMatchesCurrentPath(result, params): undefined | T

Returns only the post that matches the current path

Parameters

NameType
resultT[]
paramsPartial<P>

Returns

undefined | T

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:166


getQueriedObject

getQueriedObject(response, params): Object

Parameters

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns

Object

Inherited from

AbstractFetchStrategy.getQueriedObject

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:327


isMainQuery

isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns

boolean

Inherited from

AbstractFetchStrategy.isMainQuery

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:191


normalizeForCache

normalizeForCache(data, params): NormalizedDataForCache<T, P>

Normalize data for cache.

Parameters

NameTypeDescription
dataFetchResponse<T>The fetch response data
paramsPartial<P>The request params

Returns

NormalizedDataForCache<T, P>

Inherited from

AbstractFetchStrategy.normalizeForCache

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:379


prepareResponse

prepareResponse(response, params): FetchResponse<T>

Prepares the post response

Parameters

NameType
responseFetchResponse<T | T[]>
paramsPartial<P>

Returns

FetchResponse<T>

Overrides

AbstractFetchStrategy.prepareResponse

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:205


setBaseURL

setBaseURL(url?): void

Parameters

NameTypeDefault value
urlundefined | string''

Returns

void

Inherited from

AbstractFetchStrategy.setBaseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:150


setEndpoint

setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters

NameTypeDescription
endpointstringThe endpoint to fetch

Returns

void

Inherited from

AbstractFetchStrategy.setEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:146

- +Note that custom post types should be defined in headless.config.js

This strategy supports extracting endpoint params from url E.g:

See

getParamsFromURL to learn about url param mapping

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostParams = PostParams

Hierarchy

Constructors

constructor

new SinglePostFetchStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostParams = PostParams

Parameters

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from

AbstractFetchStrategy.constructor

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

Properties

baseURL

baseURL: string = ''

The base URL where the API is located

Inherited from

AbstractFetchStrategy.baseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:115


defaultParams

defaultParams: Partial<P> = {}

The Default Params

Inherited from

AbstractFetchStrategy.defaultParams

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:105


endpoint

endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from

AbstractFetchStrategy.endpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:110


locale

locale: string = ''

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:89


path

path: string = ''

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:87


postType

postType: string = 'post'

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:83


revision

Optional revision: PostEntity

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:85


shouldCheckCurrentPathAgainstPostLink: boolean = true

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:91

Methods

buildEndpointURL

buildEndpointURL(params): string

Handlers post types, revisions and fetching by id

Parameters

NameTypeDescription
paramsPThe params to build the endpoint url

Returns

string

Overrides

AbstractFetchStrategy.buildEndpointURL

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:127


fetcher

fetcher(url, params, options?): Promise<FetchResponse<T>>

Handles fetching by multiple post types, authToken and revisions

Parameters

NameTypeDescription
urlstringThe url to fetch
paramsPThe params to build the endpoint url
optionsPartial<FetchOptions>FetchOptions

Returns

Promise<FetchResponse<T>>

Overrides

AbstractFetchStrategy.fetcher

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:275


filterData

filterData(data, filterOptions?): any

Filters the data returned from the API by excluding fields that are not needed in order to reduce +payload size.

Parameters

NameTypeDescription
dataFetchResponse<PostEntity>The data to filter
filterOptions?FilterDataOptions<PostEntity>Filter options

Returns

any

The filtered data

Overrides

AbstractFetchStrategy.filterData

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:338


get

get(params?): Promise<FetchResponse<T>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters

NameTypeDescription
paramsPartial<P>The endpoint params

Returns

Promise<FetchResponse<T>>

Inherited from

AbstractFetchStrategy.get

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:404


getAuthHeader

getAuthHeader(options?): string

Parameters

NameType
optionsPartial<FetchOptions>

Returns

string

Inherited from

AbstractFetchStrategy.getAuthHeader

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:227


getCacheKey

getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters

NameTypeDescription
paramsPartial<P>The request params

Returns

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from

AbstractFetchStrategy.getCacheKey

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:369


getDefaultEndpoint

getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint +for the strategy

Returns

string

Overrides

AbstractFetchStrategy.getDefaultEndpoint

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:93


getDefaultParams

getDefaultParams(): Partial<P>

Returns

Partial<P>

Overrides

AbstractFetchStrategy.getDefaultParams

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:97


getEndpoint

getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, +returns the default endpoint

Returns

string

The current endpoint for the strategy

Inherited from

AbstractFetchStrategy.getEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160


getParamsFromURL

getParamsFromURL(path, nonUrlParams?): Partial<P>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support +mapping url params to endpoint params, it should return an empty object.

Parameters

NameTypeDescription
pathstringThe Path name
nonUrlParamsPartial<P>The non-url params

Returns

Partial<P>

params extracted from the URL

Overrides

AbstractFetchStrategy.getParamsFromURL

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:102


getPostThatMatchesCurrentPath

getPostThatMatchesCurrentPath(result, params): undefined | T

Returns only the post that matches the current path

Parameters

NameType
resultT[]
paramsPartial<P>

Returns

undefined | T

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:166


getQueriedObject

getQueriedObject(response, params): Object

Parameters

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns

Object

Inherited from

AbstractFetchStrategy.getQueriedObject

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:327


isMainQuery

isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns

boolean

Inherited from

AbstractFetchStrategy.isMainQuery

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:191


normalizeForCache

normalizeForCache(data, params): NormalizedDataForCache<T, P>

Normalize data for cache.

Parameters

NameTypeDescription
dataFetchResponse<T>The fetch response data
paramsPartial<P>The request params

Returns

NormalizedDataForCache<T, P>

Inherited from

AbstractFetchStrategy.normalizeForCache

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:379


prepareResponse

prepareResponse(response, params): FetchResponse<T>

Prepares the post response

Parameters

NameType
responseFetchResponse<T | T[]>
paramsPartial<P>

Returns

FetchResponse<T>

Overrides

AbstractFetchStrategy.prepareResponse

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:205


setBaseURL

setBaseURL(url?): void

Parameters

NameTypeDefault value
urlundefined | string''

Returns

void

Inherited from

AbstractFetchStrategy.setBaseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:150


setEndpoint

setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters

NameTypeDescription
endpointstringThe endpoint to fetch

Returns

void

Inherited from

AbstractFetchStrategy.setEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:146

+ \ No newline at end of file diff --git a/api/classes/headstartwp_core.TaxonomyTermsStrategy/index.html b/api/classes/headstartwp_core.TaxonomyTermsStrategy/index.html index 03dd890f7..a53a9f2ca 100644 --- a/api/classes/headstartwp_core.TaxonomyTermsStrategy/index.html +++ b/api/classes/headstartwp_core.TaxonomyTermsStrategy/index.html @@ -7,17 +7,17 @@ - +
-
Skip to main content

Class: TaxonomyTermsStrategy<T, P>

@headstartwp/core.TaxonomyTermsStrategy

This fetch strategy does not support extracting url params from the url

Type parameters

NameType
Textends TermEntity = TermEntity
Pextends TaxonomyArchiveParams = TaxonomyArchiveParams

Hierarchy

Constructors

constructor

new TaxonomyTermsStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters

NameType
Textends TermEntity = TermEntity
Pextends TaxonomyArchiveParams = TaxonomyArchiveParams

Parameters

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from

AbstractFetchStrategy.constructor

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

Properties

baseURL

baseURL: string = ''

The base URL where the API is located

Inherited from

AbstractFetchStrategy.baseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:115


defaultParams

defaultParams: Partial<P> = {}

The Default Params

Inherited from

AbstractFetchStrategy.defaultParams

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:105


defaultTaxonomy

defaultTaxonomy: string = 'category'

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:103


endpoint

endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from

AbstractFetchStrategy.endpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:110

Methods

buildEndpointURL

buildEndpointURL(params): string

Builds the final endpoint URL based on the passed parameters

Parameters

NameTypeDescription
paramsPartial<P>The params to add to the request

Returns

string

The endpoint URL.

Overrides

AbstractFetchStrategy.buildEndpointURL

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:122


fetcher

fetcher(url, params, options?): Promise<FetchResponse<T[]>>

The default fetcher function

The default fetcher function handles authentication headers and errors from the API.

A custom strategy can override this function to run additional logic before or after the fetch call

Parameters

NameTypeDescription
urlstringThe URL to fetch
paramsPartial<P>The request params
options?Partial<FetchOptions>The fetcher options

Returns

Promise<FetchResponse<T[]>>

Overrides

AbstractFetchStrategy.fetcher

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:138


filterData

filterData(data, filterOptions?): FetchResponse<T[]>

Filters the data returned from the API by excluding fields that are not needed in order to reduce -payload size.

Parameters

NameTypeDescription
dataFetchResponse<T[]>The data to filter
filterOptions?FilterDataOptions<T[]>Filter options

Returns

FetchResponse<T[]>

The filtered data

Overrides

AbstractFetchStrategy.filterData

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:146


get

get(params?): Promise<FetchResponse<T[]>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters

NameTypeDescription
paramsPartial<P>The endpoint params

Returns

Promise<FetchResponse<T[]>>

Inherited from

AbstractFetchStrategy.get

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:404


getAuthHeader

getAuthHeader(options?): string

Parameters

NameType
optionsPartial<FetchOptions>

Returns

string

Inherited from

AbstractFetchStrategy.getAuthHeader

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:227


getCacheKey

getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters

NameTypeDescription
paramsPartial<P>The request params

Returns

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from

AbstractFetchStrategy.getCacheKey

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:369


getDefaultEndpoint

getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint -for the strategy

Returns

string

Overrides

AbstractFetchStrategy.getDefaultEndpoint

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:105


getDefaultParams

getDefaultParams(): Partial<P>

Returns

Partial<P>

Overrides

AbstractFetchStrategy.getDefaultParams

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:109


getEndpoint

getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, -returns the default endpoint

Returns

string

The current endpoint for the strategy

Inherited from

AbstractFetchStrategy.getEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160


getParamsFromURL

getParamsFromURL(path, params?): Partial<P>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support -mapping url params to endpoint params, it should return an empty object.

Parameters

NameTypeDescription
pathstringThe Path name
paramsPartial<P>The non-url params

Returns

Partial<P>

params extracted from the URL

Overrides

AbstractFetchStrategy.getParamsFromURL

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:113


getQueriedObject

getQueriedObject(response, params): Object

Parameters

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns

Object

Inherited from

AbstractFetchStrategy.getQueriedObject

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:327


isMainQuery

isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns

boolean

Inherited from

AbstractFetchStrategy.isMainQuery

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:191


normalizeForCache

normalizeForCache(data, params): NormalizedDataForCache<T[], P>

Normalize data for cache.

Parameters

NameTypeDescription
dataFetchResponse<T[]>The fetch response data
paramsPartial<P>The request params

Returns

NormalizedDataForCache<T[], P>

Inherited from

AbstractFetchStrategy.normalizeForCache

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:379


prepareResponse

prepareResponse(response, params): FetchResponse<T[]>

Parameters

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns

FetchResponse<T[]>

Inherited from

AbstractFetchStrategy.prepareResponse

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:219


setBaseURL

setBaseURL(url?): void

Parameters

NameTypeDefault value
urlundefined | string''

Returns

void

Inherited from

AbstractFetchStrategy.setBaseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:150


setEndpoint

setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters

NameTypeDescription
endpointstringThe endpoint to fetch

Returns

void

Inherited from

AbstractFetchStrategy.setEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:146

- +
Skip to main content

Class: TaxonomyTermsStrategy<T, P>

@headstartwp/core.TaxonomyTermsStrategy

This fetch strategy does not support extracting url params from the url

Type parameters

NameType
Textends TermEntity = TermEntity
Pextends TaxonomyArchiveParams = TaxonomyArchiveParams

Hierarchy

Constructors

constructor

new TaxonomyTermsStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters

NameType
Textends TermEntity = TermEntity
Pextends TaxonomyArchiveParams = TaxonomyArchiveParams

Parameters

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from

AbstractFetchStrategy.constructor

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

Properties

baseURL

baseURL: string = ''

The base URL where the API is located

Inherited from

AbstractFetchStrategy.baseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:115


defaultParams

defaultParams: Partial<P> = {}

The Default Params

Inherited from

AbstractFetchStrategy.defaultParams

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:105


defaultTaxonomy

defaultTaxonomy: string = 'category'

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:103


endpoint

endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from

AbstractFetchStrategy.endpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:110

Methods

buildEndpointURL

buildEndpointURL(params): string

Builds the final endpoint URL based on the passed parameters

Parameters

NameTypeDescription
paramsPartial<P>The params to add to the request

Returns

string

The endpoint URL.

Overrides

AbstractFetchStrategy.buildEndpointURL

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:122


fetcher

fetcher(url, params, options?): Promise<FetchResponse<T[]>>

The default fetcher function

The default fetcher function handles authentication headers and errors from the API.

A custom strategy can override this function to run additional logic before or after the fetch call

Parameters

NameTypeDescription
urlstringThe URL to fetch
paramsPartial<P>The request params
options?Partial<FetchOptions>The fetcher options

Returns

Promise<FetchResponse<T[]>>

Overrides

AbstractFetchStrategy.fetcher

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:138


filterData

filterData(data, filterOptions?): FetchResponse<T[]>

Filters the data returned from the API by excluding fields that are not needed in order to reduce +payload size.

Parameters

NameTypeDescription
dataFetchResponse<T[]>The data to filter
filterOptions?FilterDataOptions<T[]>Filter options

Returns

FetchResponse<T[]>

The filtered data

Overrides

AbstractFetchStrategy.filterData

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:146


get

get(params?): Promise<FetchResponse<T[]>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters

NameTypeDescription
paramsPartial<P>The endpoint params

Returns

Promise<FetchResponse<T[]>>

Inherited from

AbstractFetchStrategy.get

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:404


getAuthHeader

getAuthHeader(options?): string

Parameters

NameType
optionsPartial<FetchOptions>

Returns

string

Inherited from

AbstractFetchStrategy.getAuthHeader

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:227


getCacheKey

getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters

NameTypeDescription
paramsPartial<P>The request params

Returns

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from

AbstractFetchStrategy.getCacheKey

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:369


getDefaultEndpoint

getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint +for the strategy

Returns

string

Overrides

AbstractFetchStrategy.getDefaultEndpoint

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:105


getDefaultParams

getDefaultParams(): Partial<P>

Returns

Partial<P>

Overrides

AbstractFetchStrategy.getDefaultParams

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:109


getEndpoint

getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, +returns the default endpoint

Returns

string

The current endpoint for the strategy

Inherited from

AbstractFetchStrategy.getEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160


getParamsFromURL

getParamsFromURL(path, params?): Partial<P>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support +mapping url params to endpoint params, it should return an empty object.

Parameters

NameTypeDescription
pathstringThe Path name
paramsPartial<P>The non-url params

Returns

Partial<P>

params extracted from the URL

Overrides

AbstractFetchStrategy.getParamsFromURL

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:113


getQueriedObject

getQueriedObject(response, params): Object

Parameters

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns

Object

Inherited from

AbstractFetchStrategy.getQueriedObject

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:327


isMainQuery

isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns

boolean

Inherited from

AbstractFetchStrategy.isMainQuery

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:191


normalizeForCache

normalizeForCache(data, params): NormalizedDataForCache<T[], P>

Normalize data for cache.

Parameters

NameTypeDescription
dataFetchResponse<T[]>The fetch response data
paramsPartial<P>The request params

Returns

NormalizedDataForCache<T[], P>

Inherited from

AbstractFetchStrategy.normalizeForCache

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:379


prepareResponse

prepareResponse(response, params): FetchResponse<T[]>

Parameters

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns

FetchResponse<T[]>

Inherited from

AbstractFetchStrategy.prepareResponse

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:219


setBaseURL

setBaseURL(url?): void

Parameters

NameTypeDefault value
urlundefined | string''

Returns

void

Inherited from

AbstractFetchStrategy.setBaseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:150


setEndpoint

setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters

NameTypeDescription
endpointstringThe endpoint to fetch

Returns

void

Inherited from

AbstractFetchStrategy.setEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:146

+ \ No newline at end of file diff --git a/api/classes/headstartwp_core.Text/index.html b/api/classes/headstartwp_core.Text/index.html index c9fbb6a02..7aa70874c 100644 --- a/api/classes/headstartwp_core.Text/index.html +++ b/api/classes/headstartwp_core.Text/index.html @@ -7,7 +7,7 @@ - + @@ -17,7 +17,7 @@ DOM spec-compatible alias.

Returns

string

Inherited from

DataNode.nodeValue

Defined in

node_modules/domhandler/lib/node.d.ts:90

set nodeValue(data): void

Parameters

NameType
datastring

Returns

void

Inherited from

DataNode.nodeValue

Defined in

node_modules/domhandler/lib/node.d.ts:91


parentNode

get parentNode(): null | ParentNode

Same as parent. DOM spec-compatible alias.

Returns

null | ParentNode

Inherited from

DataNode.parentNode

Defined in

node_modules/domhandler/lib/node.d.ts:55

set parentNode(parent): void

Parameters

NameType
parentnull | ParentNode

Returns

void

Inherited from

DataNode.parentNode

Defined in

node_modules/domhandler/lib/node.d.ts:56


previousSibling

get previousSibling(): null | ChildNode

Same as prev. DOM spec-compatible alias.

Returns

null | ChildNode

Inherited from

DataNode.previousSibling

Defined in

node_modules/domhandler/lib/node.d.ts:61

set previousSibling(prev): void

Parameters

NameType
prevnull | ChildNode

Returns

void

Inherited from

DataNode.previousSibling

Defined in

node_modules/domhandler/lib/node.d.ts:62

Methods

cloneNode

cloneNode<T>(this, recursive?): T

Clone this node, and optionally its children.

Type parameters

NameType
Textends Node<T>

Parameters

NameTypeDescription
thisT-
recursive?booleanClone child nodes as well.

Returns

T

A clone of the node.

Inherited from

DataNode.cloneNode

Defined in

node_modules/domhandler/lib/node.d.ts:75

- + \ No newline at end of file diff --git a/api/classes/headstartwp_core.VerifyTokenFetchStrategy/index.html b/api/classes/headstartwp_core.VerifyTokenFetchStrategy/index.html index 552451a7b..73c353376 100644 --- a/api/classes/headstartwp_core.VerifyTokenFetchStrategy/index.html +++ b/api/classes/headstartwp_core.VerifyTokenFetchStrategy/index.html @@ -7,18 +7,18 @@ - +
Skip to main content

Class: VerifyTokenFetchStrategy

@headstartwp/core.VerifyTokenFetchStrategy

The Verify Token strategy is used to verify tokens issued by the -headless wp plugin

Hierarchy

Constructors

constructor

new VerifyTokenFetchStrategy(baseURL?, defaultParams?)

The strategy constructor

Parameters

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<EndpointParams>(optional) list of default params

Inherited from

AbstractFetchStrategy.constructor

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

Properties

baseURL

baseURL: string = ''

The base URL where the API is located

Inherited from

AbstractFetchStrategy.baseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:115


defaultParams

defaultParams: Partial<EndpointParams> = {}

The Default Params

Inherited from

AbstractFetchStrategy.defaultParams

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:105


endpoint

endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from

AbstractFetchStrategy.endpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:110

Methods

buildEndpointURL

buildEndpointURL(params): string

Builds the final endpoint URL based on the passed parameters

Parameters

NameTypeDescription
paramsPartial<VerifyTokenParams>The params to add to the request

Returns

string

The endpoint URL.

Overrides

AbstractFetchStrategy.buildEndpointURL

Defined in

packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:32


fetcher

fetcher(url, params, options?): Promise<FetchResponse<AppEntity>>

The default fetcher function

The default fetcher function handles authentication headers and errors from the API.

A custom strategy can override this function to run additional logic before or after the fetch call

Parameters

NameTypeDescription
urlstringThe URL to fetch
paramsVerifyTokenParamsThe request params
optionsPartial<FetchOptions>The fetcher options

Returns

Promise<FetchResponse<AppEntity>>

Overrides

AbstractFetchStrategy.fetcher

Defined in

packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:39


filterData

filterData(data, filterOptions?): FetchResponse<AppEntity>

Filters the data returned from the API by excluding fields that are not needed in order to reduce -payload size.

Parameters

NameTypeDescription
dataFetchResponse<AppEntity>The data to filter
filterOptions?FilterDataOptions<AppEntity>Filter options

Returns

FetchResponse<AppEntity>

The filtered data

Inherited from

AbstractFetchStrategy.filterData

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:339


get

get(params?): Promise<FetchResponse<AppEntity>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters

NameTypeDescription
paramsPartial<EndpointParams>The endpoint params

Returns

Promise<FetchResponse<AppEntity>>

Inherited from

AbstractFetchStrategy.get

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:404


getAuthHeader

getAuthHeader(options?): string

Parameters

NameType
optionsPartial<FetchOptions>

Returns

string

Inherited from

AbstractFetchStrategy.getAuthHeader

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:227


getCacheKey

getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters

NameTypeDescription
paramsPartial<EndpointParams>The request params

Returns

Object

The cache key object

NameType
argsPartial<EndpointParams> & { sourceUrl: string }
urlstring

Inherited from

AbstractFetchStrategy.getCacheKey

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:369


getDefaultEndpoint

getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint -for the strategy

Returns

string

Overrides

AbstractFetchStrategy.getDefaultEndpoint

Defined in

packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:23


getDefaultParams

getDefaultParams(): Partial<EndpointParams>

Returns

Partial<EndpointParams>

Inherited from

AbstractFetchStrategy.getDefaultParams

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:168


getEndpoint

getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, -returns the default endpoint

Returns

string

The current endpoint for the strategy

Inherited from

AbstractFetchStrategy.getEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160


getParamsFromURL

getParamsFromURL(path, params?): Partial<EndpointParams>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support -mapping url params to endpoint params, it should return an empty object.

Parameters

NameTypeDescription
pathstringThe Path name
paramsPartial<EndpointParams>The non-url params

Returns

Partial<EndpointParams>

params extracted from the URL

Overrides

AbstractFetchStrategy.getParamsFromURL

Defined in

packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:28


getQueriedObject

getQueriedObject(response, params): Object

Parameters

NameType
responseFetchResponse<AppEntity>
paramsPartial<EndpointParams>

Returns

Object

Inherited from

AbstractFetchStrategy.getQueriedObject

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:327


isMainQuery

isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<EndpointParams>The non-url params

Returns

boolean

Inherited from

AbstractFetchStrategy.isMainQuery

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:191


normalizeForCache

normalizeForCache(data, params): NormalizedDataForCache<AppEntity, EndpointParams>

Normalize data for cache.

Parameters

NameTypeDescription
dataFetchResponse<AppEntity>The fetch response data
paramsPartial<EndpointParams>The request params

Returns

NormalizedDataForCache<AppEntity, EndpointParams>

Inherited from

AbstractFetchStrategy.normalizeForCache

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:379


prepareResponse

prepareResponse(response, params): FetchResponse<AppEntity>

Parameters

NameType
responseFetchResponse<AppEntity>
paramsPartial<EndpointParams>

Returns

FetchResponse<AppEntity>

Inherited from

AbstractFetchStrategy.prepareResponse

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:219


setBaseURL

setBaseURL(url?): void

Parameters

NameTypeDefault value
urlundefined | string''

Returns

void

Inherited from

AbstractFetchStrategy.setBaseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:150


setEndpoint

setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters

NameTypeDescription
endpointstringThe endpoint to fetch

Returns

void

Inherited from

AbstractFetchStrategy.setEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:146

- +headless wp plugin

Hierarchy

Constructors

constructor

new VerifyTokenFetchStrategy(baseURL?, defaultParams?)

The strategy constructor

Parameters

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<EndpointParams>(optional) list of default params

Inherited from

AbstractFetchStrategy.constructor

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

Properties

baseURL

baseURL: string = ''

The base URL where the API is located

Inherited from

AbstractFetchStrategy.baseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:115


defaultParams

defaultParams: Partial<EndpointParams> = {}

The Default Params

Inherited from

AbstractFetchStrategy.defaultParams

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:105


endpoint

endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from

AbstractFetchStrategy.endpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:110

Methods

buildEndpointURL

buildEndpointURL(params): string

Builds the final endpoint URL based on the passed parameters

Parameters

NameTypeDescription
paramsPartial<VerifyTokenParams>The params to add to the request

Returns

string

The endpoint URL.

Overrides

AbstractFetchStrategy.buildEndpointURL

Defined in

packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:32


fetcher

fetcher(url, params, options?): Promise<FetchResponse<AppEntity>>

The default fetcher function

The default fetcher function handles authentication headers and errors from the API.

A custom strategy can override this function to run additional logic before or after the fetch call

Parameters

NameTypeDescription
urlstringThe URL to fetch
paramsVerifyTokenParamsThe request params
optionsPartial<FetchOptions>The fetcher options

Returns

Promise<FetchResponse<AppEntity>>

Overrides

AbstractFetchStrategy.fetcher

Defined in

packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:39


filterData

filterData(data, filterOptions?): FetchResponse<AppEntity>

Filters the data returned from the API by excluding fields that are not needed in order to reduce +payload size.

Parameters

NameTypeDescription
dataFetchResponse<AppEntity>The data to filter
filterOptions?FilterDataOptions<AppEntity>Filter options

Returns

FetchResponse<AppEntity>

The filtered data

Inherited from

AbstractFetchStrategy.filterData

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:339


get

get(params?): Promise<FetchResponse<AppEntity>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters

NameTypeDescription
paramsPartial<EndpointParams>The endpoint params

Returns

Promise<FetchResponse<AppEntity>>

Inherited from

AbstractFetchStrategy.get

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:404


getAuthHeader

getAuthHeader(options?): string

Parameters

NameType
optionsPartial<FetchOptions>

Returns

string

Inherited from

AbstractFetchStrategy.getAuthHeader

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:227


getCacheKey

getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters

NameTypeDescription
paramsPartial<EndpointParams>The request params

Returns

Object

The cache key object

NameType
argsPartial<EndpointParams> & { sourceUrl: string }
urlstring

Inherited from

AbstractFetchStrategy.getCacheKey

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:369


getDefaultEndpoint

getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint +for the strategy

Returns

string

Overrides

AbstractFetchStrategy.getDefaultEndpoint

Defined in

packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:23


getDefaultParams

getDefaultParams(): Partial<EndpointParams>

Returns

Partial<EndpointParams>

Inherited from

AbstractFetchStrategy.getDefaultParams

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:168


getEndpoint

getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, +returns the default endpoint

Returns

string

The current endpoint for the strategy

Inherited from

AbstractFetchStrategy.getEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160


getParamsFromURL

getParamsFromURL(path, params?): Partial<EndpointParams>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support +mapping url params to endpoint params, it should return an empty object.

Parameters

NameTypeDescription
pathstringThe Path name
paramsPartial<EndpointParams>The non-url params

Returns

Partial<EndpointParams>

params extracted from the URL

Overrides

AbstractFetchStrategy.getParamsFromURL

Defined in

packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:28


getQueriedObject

getQueriedObject(response, params): Object

Parameters

NameType
responseFetchResponse<AppEntity>
paramsPartial<EndpointParams>

Returns

Object

Inherited from

AbstractFetchStrategy.getQueriedObject

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:327


isMainQuery

isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<EndpointParams>The non-url params

Returns

boolean

Inherited from

AbstractFetchStrategy.isMainQuery

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:191


normalizeForCache

normalizeForCache(data, params): NormalizedDataForCache<AppEntity, EndpointParams>

Normalize data for cache.

Parameters

NameTypeDescription
dataFetchResponse<AppEntity>The fetch response data
paramsPartial<EndpointParams>The request params

Returns

NormalizedDataForCache<AppEntity, EndpointParams>

Inherited from

AbstractFetchStrategy.normalizeForCache

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:379


prepareResponse

prepareResponse(response, params): FetchResponse<AppEntity>

Parameters

NameType
responseFetchResponse<AppEntity>
paramsPartial<EndpointParams>

Returns

FetchResponse<AppEntity>

Inherited from

AbstractFetchStrategy.prepareResponse

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:219


setBaseURL

setBaseURL(url?): void

Parameters

NameTypeDefault value
urlundefined | string''

Returns

void

Inherited from

AbstractFetchStrategy.setBaseURL

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:150


setEndpoint

setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters

NameTypeDescription
endpointstringThe endpoint to fetch

Returns

void

Inherited from

AbstractFetchStrategy.setEndpoint

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:146

+ \ No newline at end of file diff --git a/api/enums/headstartwp_core.LOGTYPE/index.html b/api/enums/headstartwp_core.LOGTYPE/index.html index 7d88e7ebc..92ff31690 100644 --- a/api/enums/headstartwp_core.LOGTYPE/index.html +++ b/api/enums/headstartwp_core.LOGTYPE/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content
- +
Skip to main content
+ \ No newline at end of file diff --git a/api/index.html b/api/index.html index f3ef1ad96..007d398b7 100644 --- a/api/index.html +++ b/api/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.AppEntity/index.html b/api/interfaces/headstartwp_core.AppEntity/index.html index e8b6eeae8..c980076de 100644 --- a/api/interfaces/headstartwp_core.AppEntity/index.html +++ b/api/interfaces/headstartwp_core.AppEntity/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: AppEntity

@headstartwp/core.AppEntity

Empty interface from which all entities inherit.

Hierarchy

Properties

home

home: Object

Type declaration

NameType
id?number
slug?string

Defined in

packages/core/src/data/types/entities.ts:681


menus: Object

Index signature

[k: string]: MenuItemEntity[]

Defined in

packages/core/src/data/types/entities.ts:678


settings

settings: Object

Type declaration

NameType
posts_per_pagestring
privacy_policy_urlstring
site_descstring
site_namestring
site_rss_urlstring
site_wp_urlstring

Defined in

packages/core/src/data/types/entities.ts:685


theme.json

theme.json: Record<string, any>

Defined in

packages/core/src/data/types/entities.ts:693


yoast_head

Optional yoast_head: null | string

Inherited from

Entity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:14


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Inherited from

Entity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:13

- +
Skip to main content

Interface: AppEntity

@headstartwp/core.AppEntity

Empty interface from which all entities inherit.

Hierarchy

Properties

home

home: Object

Type declaration

NameType
id?number
slug?string

Defined in

packages/core/src/data/types/entities.ts:681


menus: Object

Index signature

[k: string]: MenuItemEntity[]

Defined in

packages/core/src/data/types/entities.ts:678


settings

settings: Object

Type declaration

NameType
posts_per_pagestring
privacy_policy_urlstring
site_descstring
site_namestring
site_rss_urlstring
site_wp_urlstring

Defined in

packages/core/src/data/types/entities.ts:685


theme.json

theme.json: Record<string, any>

Defined in

packages/core/src/data/types/entities.ts:693


yoast_head

Optional yoast_head: null | string

Inherited from

Entity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:14


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Inherited from

Entity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:13

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.AttachmentEntity/index.html b/api/interfaces/headstartwp_core.AttachmentEntity/index.html index f08e8cebd..6d3b70073 100644 --- a/api/interfaces/headstartwp_core.AttachmentEntity/index.html +++ b/api/interfaces/headstartwp_core.AttachmentEntity/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: AttachmentEntity

@headstartwp/core.AttachmentEntity

Interface for entities from the /wp/v2/media endpoint.

Hierarchy

Properties

_embedded

_embedded: Object

Type declaration

NameType
authorAuthorEntity[]
wp:termTermEntity[][]

Inherited from

PostTypeEntity._embedded

Defined in

packages/core/src/data/types/entities.ts:98


alt_text

alt_text: string

Alternative text to display when attachment is not displayed.

Defined in

packages/core/src/data/types/entities.ts:259


author

Optional author: AuthorEntity[]

Inherited from

PostTypeEntity.author

Defined in

packages/core/src/data/types/entities.ts:94


caption

caption: Rendered

The attachment caption.

Defined in

packages/core/src/data/types/entities.ts:264


comment_status

Optional comment_status: "open" | "closed"

Whether or not comments are open on the object.

Inherited from

PostTypeEntity.comment_status

Defined in

packages/core/src/data/types/entities.ts:106


date

date: string

The date the object was published, in the site's timezone.

Inherited from

PostTypeEntity.date

Defined in

packages/core/src/data/types/entities.ts:42


date_gmt

date_gmt: string

The date the object was published, as GMT.

Inherited from

PostTypeEntity.date_gmt

Defined in

packages/core/src/data/types/entities.ts:47


description

description: Rendered

The attachment description.

Defined in

packages/core/src/data/types/entities.ts:269


guid

guid: Rendered

The globally unique identifier for the object.

Inherited from

PostTypeEntity.guid

Defined in

packages/core/src/data/types/entities.ts:52


id

id: number

Unique identifier for the object.

Inherited from

PostTypeEntity.id

Defined in

packages/core/src/data/types/entities.ts:67


link: string

URL to the object.

Inherited from

PostTypeEntity.link

Defined in

packages/core/src/data/types/entities.ts:72


media_details

Optional media_details: Object

Details about the media file, specific to its type.

Type declaration

NameTypeDescription
filestringThe file path relative to wp-content/uploads.
heightnumberThe height of the attachment.
image_metaRecord<string, unknown>The metadata of the attachment.
sizesRecord<string, { file: string ; height: number ; mime_type: string ; source_url: string ; width: number }>The different sizes that WordPress created for this attachment.
widthnumberThe width of the attachment.

Defined in

packages/core/src/data/types/entities.ts:284


media_type

media_type: "image" | "file"

Attachment type.

Defined in

packages/core/src/data/types/entities.ts:274


meta

Optional meta: Record<string, unknown>

Meta fields.

Defined in

packages/core/src/data/types/entities.ts:249


mime_type

mime_type: string

The attachment MIME type.

Defined in

packages/core/src/data/types/entities.ts:279


missing_image_sizes

missing_image_sizes: string[]

List of the missing image sizes of the attachment.

Defined in

packages/core/src/data/types/entities.ts:352


modified

modified: string

The date the object was last modified, in the site's timezone.

Inherited from

PostTypeEntity.modified

Defined in

packages/core/src/data/types/entities.ts:57


modified_gmt

modified_gmt: string

The date the object was last modified, as GMT.

Inherited from

PostTypeEntity.modified_gmt

Defined in

packages/core/src/data/types/entities.ts:62


ping_status

ping_status: "open" | "closed"

Whether or not the object can be pinged.

Inherited from

PostTypeEntity.ping_status

Defined in

packages/core/src/data/types/entities.ts:111


post

post: number

The ID for the associated post of the attachment.

Defined in

packages/core/src/data/types/entities.ts:342


slug

slug: string

An alphanumeric identifier for the object unique to its type.

Inherited from

PostTypeEntity.slug

Defined in

packages/core/src/data/types/entities.ts:77


source_url

source_url: string

URL to the original attachment file.

Defined in

packages/core/src/data/types/entities.ts:347


status

status: "publish" | "future" | "draft" | "pending" | "private"

A named status for the object.

Inherited from

PostTypeEntity.status

Defined in

packages/core/src/data/types/entities.ts:82


template

Optional template: string

The theme file to use to display the object.

Defined in

packages/core/src/data/types/entities.ts:254


terms

Optional terms: Record<string, TermEntity[]>

Inherited from

PostTypeEntity.terms

Defined in

packages/core/src/data/types/entities.ts:96


title

title: Rendered

The title for the object.

Inherited from

PostTypeEntity.title

Defined in

packages/core/src/data/types/entities.ts:92


type

type: "attachment"

Type of Post for the object.

Overrides

PostTypeEntity.type

Defined in

packages/core/src/data/types/entities.ts:244


yoast_head

Optional yoast_head: null | string

Inherited from

PostTypeEntity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:114


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Inherited from

PostTypeEntity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:113

- +
Skip to main content

Interface: AttachmentEntity

@headstartwp/core.AttachmentEntity

Interface for entities from the /wp/v2/media endpoint.

Hierarchy

Properties

_embedded

_embedded: Object

Type declaration

NameType
authorAuthorEntity[]
wp:termTermEntity[][]

Inherited from

PostTypeEntity._embedded

Defined in

packages/core/src/data/types/entities.ts:98


alt_text

alt_text: string

Alternative text to display when attachment is not displayed.

Defined in

packages/core/src/data/types/entities.ts:259


author

Optional author: AuthorEntity[]

Inherited from

PostTypeEntity.author

Defined in

packages/core/src/data/types/entities.ts:94


caption

caption: Rendered

The attachment caption.

Defined in

packages/core/src/data/types/entities.ts:264


comment_status

Optional comment_status: "open" | "closed"

Whether or not comments are open on the object.

Inherited from

PostTypeEntity.comment_status

Defined in

packages/core/src/data/types/entities.ts:106


date

date: string

The date the object was published, in the site's timezone.

Inherited from

PostTypeEntity.date

Defined in

packages/core/src/data/types/entities.ts:42


date_gmt

date_gmt: string

The date the object was published, as GMT.

Inherited from

PostTypeEntity.date_gmt

Defined in

packages/core/src/data/types/entities.ts:47


description

description: Rendered

The attachment description.

Defined in

packages/core/src/data/types/entities.ts:269


guid

guid: Rendered

The globally unique identifier for the object.

Inherited from

PostTypeEntity.guid

Defined in

packages/core/src/data/types/entities.ts:52


id

id: number

Unique identifier for the object.

Inherited from

PostTypeEntity.id

Defined in

packages/core/src/data/types/entities.ts:67


link: string

URL to the object.

Inherited from

PostTypeEntity.link

Defined in

packages/core/src/data/types/entities.ts:72


media_details

Optional media_details: Object

Details about the media file, specific to its type.

Type declaration

NameTypeDescription
filestringThe file path relative to wp-content/uploads.
heightnumberThe height of the attachment.
image_metaRecord<string, unknown>The metadata of the attachment.
sizesRecord<string, { file: string ; height: number ; mime_type: string ; source_url: string ; width: number }>The different sizes that WordPress created for this attachment.
widthnumberThe width of the attachment.

Defined in

packages/core/src/data/types/entities.ts:284


media_type

media_type: "image" | "file"

Attachment type.

Defined in

packages/core/src/data/types/entities.ts:274


meta

Optional meta: Record<string, unknown>

Meta fields.

Defined in

packages/core/src/data/types/entities.ts:249


mime_type

mime_type: string

The attachment MIME type.

Defined in

packages/core/src/data/types/entities.ts:279


missing_image_sizes

missing_image_sizes: string[]

List of the missing image sizes of the attachment.

Defined in

packages/core/src/data/types/entities.ts:352


modified

modified: string

The date the object was last modified, in the site's timezone.

Inherited from

PostTypeEntity.modified

Defined in

packages/core/src/data/types/entities.ts:57


modified_gmt

modified_gmt: string

The date the object was last modified, as GMT.

Inherited from

PostTypeEntity.modified_gmt

Defined in

packages/core/src/data/types/entities.ts:62


ping_status

ping_status: "open" | "closed"

Whether or not the object can be pinged.

Inherited from

PostTypeEntity.ping_status

Defined in

packages/core/src/data/types/entities.ts:111


post

post: number

The ID for the associated post of the attachment.

Defined in

packages/core/src/data/types/entities.ts:342


slug

slug: string

An alphanumeric identifier for the object unique to its type.

Inherited from

PostTypeEntity.slug

Defined in

packages/core/src/data/types/entities.ts:77


source_url

source_url: string

URL to the original attachment file.

Defined in

packages/core/src/data/types/entities.ts:347


status

status: "publish" | "future" | "draft" | "pending" | "private"

A named status for the object.

Inherited from

PostTypeEntity.status

Defined in

packages/core/src/data/types/entities.ts:82


template

Optional template: string

The theme file to use to display the object.

Defined in

packages/core/src/data/types/entities.ts:254


terms

Optional terms: Record<string, TermEntity[]>

Inherited from

PostTypeEntity.terms

Defined in

packages/core/src/data/types/entities.ts:96


title

title: Rendered

The title for the object.

Inherited from

PostTypeEntity.title

Defined in

packages/core/src/data/types/entities.ts:92


type

type: "attachment"

Type of Post for the object.

Overrides

PostTypeEntity.type

Defined in

packages/core/src/data/types/entities.ts:244


yoast_head

Optional yoast_head: null | string

Inherited from

PostTypeEntity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:114


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Inherited from

PostTypeEntity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:113

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.AuthorEntity/index.html b/api/interfaces/headstartwp_core.AuthorEntity/index.html index 99c471200..ac0f6af3e 100644 --- a/api/interfaces/headstartwp_core.AuthorEntity/index.html +++ b/api/interfaces/headstartwp_core.AuthorEntity/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: AuthorEntity

@headstartwp/core.AuthorEntity

Interface for entities from the /wp/v2/users endpoint.

Hierarchy

Properties

avatar_urls

Optional avatar_urls: AvatarUrls

Avatar URLs for the user.

Defined in

packages/core/src/data/types/entities.ts:540


description

description: string

Description of the user.

Defined in

packages/core/src/data/types/entities.ts:525


id

id: number

Unique identifier for the user.

Defined in

packages/core/src/data/types/entities.ts:510


link: string

Author URL of the user.

Defined in

packages/core/src/data/types/entities.ts:530


meta

meta: Record<string, unknown>

Meta fields.

Defined in

packages/core/src/data/types/entities.ts:545


name

name: string

Display name for the user.

Defined in

packages/core/src/data/types/entities.ts:515


slug

slug: string

An alphanumeric identifier for the user.

Defined in

packages/core/src/data/types/entities.ts:535


url

url: string

URL of the user.

Defined in

packages/core/src/data/types/entities.ts:520


yoast_head

Optional yoast_head: null | string

Overrides

Entity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:548


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Overrides

Entity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:547

- +
Skip to main content

Interface: AuthorEntity

@headstartwp/core.AuthorEntity

Interface for entities from the /wp/v2/users endpoint.

Hierarchy

Properties

avatar_urls

Optional avatar_urls: AvatarUrls

Avatar URLs for the user.

Defined in

packages/core/src/data/types/entities.ts:540


description

description: string

Description of the user.

Defined in

packages/core/src/data/types/entities.ts:525


id

id: number

Unique identifier for the user.

Defined in

packages/core/src/data/types/entities.ts:510


link: string

Author URL of the user.

Defined in

packages/core/src/data/types/entities.ts:530


meta

meta: Record<string, unknown>

Meta fields.

Defined in

packages/core/src/data/types/entities.ts:545


name

name: string

Display name for the user.

Defined in

packages/core/src/data/types/entities.ts:515


slug

slug: string

An alphanumeric identifier for the user.

Defined in

packages/core/src/data/types/entities.ts:535


url

url: string

URL of the user.

Defined in

packages/core/src/data/types/entities.ts:520


yoast_head

Optional yoast_head: null | string

Overrides

Entity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:548


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Overrides

Entity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:547

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.AvatarUrls/index.html b/api/interfaces/headstartwp_core.AvatarUrls/index.html index 6ba08e8d0..f58c0430f 100644 --- a/api/interfaces/headstartwp_core.AvatarUrls/index.html +++ b/api/interfaces/headstartwp_core.AvatarUrls/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: AvatarUrls

@headstartwp/core.AvatarUrls

Map of avatar URLs by their size.

Indexable

[k: string]: unknown

Properties

24

Optional 24: string

Avatar URL with image size of 24 pixels.

Defined in

packages/core/src/data/types/entities.ts:489


48

Optional 48: string

Avatar URL with image size of 48 pixels.

Defined in

packages/core/src/data/types/entities.ts:494


96

Optional 96: string

Avatar URL with image size of 96 pixels.

Defined in

packages/core/src/data/types/entities.ts:499

- +
Skip to main content

Interface: AvatarUrls

@headstartwp/core.AvatarUrls

Map of avatar URLs by their size.

Indexable

[k: string]: unknown

Properties

24

Optional 24: string

Avatar URL with image size of 24 pixels.

Defined in

packages/core/src/data/types/entities.ts:489


48

Optional 48: string

Avatar URL with image size of 48 pixels.

Defined in

packages/core/src/data/types/entities.ts:494


96

Optional 96: string

Avatar URL with image size of 96 pixels.

Defined in

packages/core/src/data/types/entities.ts:499

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.CommentEntity/index.html b/api/interfaces/headstartwp_core.CommentEntity/index.html index c718c520c..677dca9f4 100644 --- a/api/interfaces/headstartwp_core.CommentEntity/index.html +++ b/api/interfaces/headstartwp_core.CommentEntity/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: CommentEntity

@headstartwp/core.CommentEntity

Interface for entities from the /wp/v2/comments endpoint.

Hierarchy

Properties

author

author: number

The ID of the user object, if author was a user.

Defined in

packages/core/src/data/types/entities.ts:563


author_avatar_urls

author_avatar_urls: AvatarUrls

Avatar URLs for the object author.

Defined in

packages/core/src/data/types/entities.ts:623


author_email

author_email: string

Email address for the object author.

Defined in

packages/core/src/data/types/entities.ts:568


author_name

author_name: string

Display name for the object author.

Defined in

packages/core/src/data/types/entities.ts:573


author_url

author_url: string

URL for the object author.

Defined in

packages/core/src/data/types/entities.ts:578


content

content: Rendered

The content for the object.

Defined in

packages/core/src/data/types/entities.ts:583


date

date: string

The date the object was published, in the site's timezone.

Defined in

packages/core/src/data/types/entities.ts:588


date_gmt

date_gmt: string

The date the object was published, as GMT.

Defined in

packages/core/src/data/types/entities.ts:593


id

id: number

Unique identifier for the object.

Defined in

packages/core/src/data/types/entities.ts:558


link: string

URL to the object.

Defined in

packages/core/src/data/types/entities.ts:598


meta

meta: Record<string, unknown>

Meta fields.

Defined in

packages/core/src/data/types/entities.ts:628


parent

parent: number

The ID for the parent of the object.

Defined in

packages/core/src/data/types/entities.ts:603


post

post: number

The ID of the associated post object.

Defined in

packages/core/src/data/types/entities.ts:608


status

status: string

State of the object.

Defined in

packages/core/src/data/types/entities.ts:613


type

type: "comment"

Type of Comment for the object.

Defined in

packages/core/src/data/types/entities.ts:618


yoast_head

Optional yoast_head: null | string

Inherited from

Entity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:14


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Inherited from

Entity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:13

- +
Skip to main content

Interface: CommentEntity

@headstartwp/core.CommentEntity

Interface for entities from the /wp/v2/comments endpoint.

Hierarchy

Properties

author

author: number

The ID of the user object, if author was a user.

Defined in

packages/core/src/data/types/entities.ts:563


author_avatar_urls

author_avatar_urls: AvatarUrls

Avatar URLs for the object author.

Defined in

packages/core/src/data/types/entities.ts:623


author_email

author_email: string

Email address for the object author.

Defined in

packages/core/src/data/types/entities.ts:568


author_name

author_name: string

Display name for the object author.

Defined in

packages/core/src/data/types/entities.ts:573


author_url

author_url: string

URL for the object author.

Defined in

packages/core/src/data/types/entities.ts:578


content

content: Rendered

The content for the object.

Defined in

packages/core/src/data/types/entities.ts:583


date

date: string

The date the object was published, in the site's timezone.

Defined in

packages/core/src/data/types/entities.ts:588


date_gmt

date_gmt: string

The date the object was published, as GMT.

Defined in

packages/core/src/data/types/entities.ts:593


id

id: number

Unique identifier for the object.

Defined in

packages/core/src/data/types/entities.ts:558


link: string

URL to the object.

Defined in

packages/core/src/data/types/entities.ts:598


meta

meta: Record<string, unknown>

Meta fields.

Defined in

packages/core/src/data/types/entities.ts:628


parent

parent: number

The ID for the parent of the object.

Defined in

packages/core/src/data/types/entities.ts:603


post

post: number

The ID of the associated post object.

Defined in

packages/core/src/data/types/entities.ts:608


status

status: string

State of the object.

Defined in

packages/core/src/data/types/entities.ts:613


type

type: "comment"

Type of Comment for the object.

Defined in

packages/core/src/data/types/entities.ts:618


yoast_head

Optional yoast_head: null | string

Inherited from

Entity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:14


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Inherited from

Entity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:13

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.EndpointParams/index.html b/api/interfaces/headstartwp_core.EndpointParams/index.html index 1f678f936..2a5790ed2 100644 --- a/api/interfaces/headstartwp_core.EndpointParams/index.html +++ b/api/interfaces/headstartwp_core.EndpointParams/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: EndpointParams

@headstartwp/core.EndpointParams

The base interface for defining endpoint parameters

Strategies should define type with the actually supported EndPointParams

Hierarchy

Indexable

[k: string]: unknown

Properties

_embed

Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17


_fields

Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22


lang

Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29

- +
Skip to main content

Interface: EndpointParams

@headstartwp/core.EndpointParams

The base interface for defining endpoint parameters

Strategies should define type with the actually supported EndPointParams

Hierarchy

Indexable

[k: string]: unknown

Properties

_embed

Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17


_fields

Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22


lang

Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.Entity/index.html b/api/interfaces/headstartwp_core.Entity/index.html index ffdc29a24..bdfcb71cb 100644 --- a/api/interfaces/headstartwp_core.Entity/index.html +++ b/api/interfaces/headstartwp_core.Entity/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: Entity

@headstartwp/core.Entity

Empty interface from which all entities inherit.

Hierarchy

Indexable

[k: string]: unknown

Properties

yoast_head

Optional yoast_head: null | string

Defined in

packages/core/src/data/types/entities.ts:14


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Defined in

packages/core/src/data/types/entities.ts:13

- +
Skip to main content

Interface: Entity

@headstartwp/core.Entity

Empty interface from which all entities inherit.

Hierarchy

Indexable

[k: string]: unknown

Properties

yoast_head

Optional yoast_head: null | string

Defined in

packages/core/src/data/types/entities.ts:14


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Defined in

packages/core/src/data/types/entities.ts:13

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.FetchOptions/index.html b/api/interfaces/headstartwp_core.FetchOptions/index.html index 162533d28..61758b2cf 100644 --- a/api/interfaces/headstartwp_core.FetchOptions/index.html +++ b/api/interfaces/headstartwp_core.FetchOptions/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: FetchOptions

@headstartwp/core.FetchOptions

The options supported by the default fetcher method

Properties

bearerToken

Optional bearerToken: string

The authentication token to use for the request.

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:66


burstCache

Optional burstCache: boolean

Whether to burst cache by appending a timestamp to the query

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:71


throwIfNotFound

throwIfNotFound: boolean

Whether to thrown an exception if data is not found.

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:61

- +
Skip to main content

Interface: FetchOptions

@headstartwp/core.FetchOptions

The options supported by the default fetcher method

Properties

bearerToken

Optional bearerToken: string

The authentication token to use for the request.

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:66


burstCache

Optional burstCache: boolean

Whether to burst cache by appending a timestamp to the query

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:71


throwIfNotFound

throwIfNotFound: boolean

Whether to thrown an exception if data is not found.

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:61

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.FetchResponse/index.html b/api/interfaces/headstartwp_core.FetchResponse/index.html index db0bc40be..1ce8575d7 100644 --- a/api/interfaces/headstartwp_core.FetchResponse/index.html +++ b/api/interfaces/headstartwp_core.FetchResponse/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: FetchResponse<T>

@headstartwp/core.FetchResponse

The type of the fetch response

Type parameters

Name
T

Properties

pageInfo

pageInfo: PageInfo

Contains pagination information

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:46


queriedObject

queriedObject: QueriedObject

Queried Object information

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:51


result

result: T

Contains the actual data returned from the API

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:41

- +
Skip to main content

Interface: FetchResponse<T>

@headstartwp/core.FetchResponse

The type of the fetch response

Type parameters

Name
T

Properties

pageInfo

pageInfo: PageInfo

Contains pagination information

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:46


queriedObject

queriedObject: QueriedObject

Queried Object information

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:51


result

result: T

Contains the actual data returned from the API

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:41

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.FilterDataOptions/index.html b/api/interfaces/headstartwp_core.FilterDataOptions/index.html index f617e30f0..8ab20029b 100644 --- a/api/interfaces/headstartwp_core.FilterDataOptions/index.html +++ b/api/interfaces/headstartwp_core.FilterDataOptions/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: FilterDataOptions<T>

@headstartwp/core.FilterDataOptions

Type parameters

Name
T

Properties

fields

fields: keyof T[]

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:80


method

method: "ALLOW" | "REMOVE"

If method is 'ALLOW' then only the fields specified in the filter will be returned. -If method is 'REMOVE' then the fields specified in the filter will be removed.

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:79

- +
Skip to main content

Interface: FilterDataOptions<T>

@headstartwp/core.FilterDataOptions

Type parameters

Name
T

Properties

fields

fields: keyof T[]

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:80


method

method: "ALLOW" | "REMOVE"

If method is 'ALLOW' then only the fields specified in the filter will be returned. +If method is 'REMOVE' then the fields specified in the filter will be removed.

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:79

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.HTMLReactParserOptions/index.html b/api/interfaces/headstartwp_core.HTMLReactParserOptions/index.html index 1f97fc424..244b28d2a 100644 --- a/api/interfaces/headstartwp_core.HTMLReactParserOptions/index.html +++ b/api/interfaces/headstartwp_core.HTMLReactParserOptions/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

Interface: HTMLReactParserOptions

@headstartwp/core.HTMLReactParserOptions

Properties

htmlparser2

Optional htmlparser2: HTMLParser2Options

Defined in

node_modules/html-react-parser/index.d.ts:24


library

Optional library: Object

Index signature

[key: string]: any

Type declaration

NameType
cloneElement(element: Element, props?: object, ...children: any) => Element
createElement(type: any, props?: object, ...children: any) => Element
isValidElement(element: any) => boolean

Defined in

node_modules/html-react-parser/index.d.ts:26


replace

Optional replace: (domNode: DOMNode) => undefined | null | false | void | object | Element

Type declaration

▸ (domNode): undefined | null | false | void | object | Element

Parameters
NameType
domNodeDOMNode
Returns

undefined | null | false | void | object | Element

Defined in

node_modules/html-react-parser/index.d.ts:37


trim

Optional trim: boolean

Defined in

node_modules/html-react-parser/index.d.ts:41

- + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.Integration/index.html b/api/interfaces/headstartwp_core.Integration/index.html index 102cdd1b4..8f5999dcc 100644 --- a/api/interfaces/headstartwp_core.Integration/index.html +++ b/api/interfaces/headstartwp_core.Integration/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content
- +
Skip to main content
+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.MenuItemEntity/index.html b/api/interfaces/headstartwp_core.MenuItemEntity/index.html index 398b4083b..9c84926ca 100644 --- a/api/interfaces/headstartwp_core.MenuItemEntity/index.html +++ b/api/interfaces/headstartwp_core.MenuItemEntity/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: MenuItemEntity

@headstartwp/core.MenuItemEntity

Properties

ID

ID: number

Defined in

packages/core/src/data/types/entities.ts:657


attr_title

attr_title: string

Defined in

packages/core/src/data/types/entities.ts:669


children

children: MenuItemEntity[]

Defined in

packages/core/src/data/types/entities.ts:673


classes

classes: string[]

Defined in

packages/core/src/data/types/entities.ts:671


description

description: string

Defined in

packages/core/src/data/types/entities.ts:670


menu_item_parent: string

Defined in

packages/core/src/data/types/entities.ts:661


menu_order: number

Defined in

packages/core/src/data/types/entities.ts:658


object

object: string

Defined in

packages/core/src/data/types/entities.ts:663


object_id

object_id: string

Defined in

packages/core/src/data/types/entities.ts:662


order

order: number

Defined in

packages/core/src/data/types/entities.ts:674


post_mime_type

post_mime_type: string

Defined in

packages/core/src/data/types/entities.ts:660


post_type

post_type: string

Defined in

packages/core/src/data/types/entities.ts:659


slug

slug: string

Defined in

packages/core/src/data/types/entities.ts:672


target

target: "_blank" | "_self" | "_parent" | "_top"

Defined in

packages/core/src/data/types/entities.ts:668


title

title: string

Defined in

packages/core/src/data/types/entities.ts:667


type

type: string

Defined in

packages/core/src/data/types/entities.ts:664


type_label

type_label: string

Defined in

packages/core/src/data/types/entities.ts:665


url

url: string

Defined in

packages/core/src/data/types/entities.ts:666

- +
Skip to main content

Interface: MenuItemEntity

@headstartwp/core.MenuItemEntity

Properties

ID

ID: number

Defined in

packages/core/src/data/types/entities.ts:657


attr_title

attr_title: string

Defined in

packages/core/src/data/types/entities.ts:669


children

children: MenuItemEntity[]

Defined in

packages/core/src/data/types/entities.ts:673


classes

classes: string[]

Defined in

packages/core/src/data/types/entities.ts:671


description

description: string

Defined in

packages/core/src/data/types/entities.ts:670


menu_item_parent: string

Defined in

packages/core/src/data/types/entities.ts:661


menu_order: number

Defined in

packages/core/src/data/types/entities.ts:658


object

object: string

Defined in

packages/core/src/data/types/entities.ts:663


object_id

object_id: string

Defined in

packages/core/src/data/types/entities.ts:662


order

order: number

Defined in

packages/core/src/data/types/entities.ts:674


post_mime_type

post_mime_type: string

Defined in

packages/core/src/data/types/entities.ts:660


post_type

post_type: string

Defined in

packages/core/src/data/types/entities.ts:659


slug

slug: string

Defined in

packages/core/src/data/types/entities.ts:672


target

target: "_blank" | "_self" | "_parent" | "_top"

Defined in

packages/core/src/data/types/entities.ts:668


title

title: string

Defined in

packages/core/src/data/types/entities.ts:667


type

type: string

Defined in

packages/core/src/data/types/entities.ts:664


type_label

type_label: string

Defined in

packages/core/src/data/types/entities.ts:665


url

url: string

Defined in

packages/core/src/data/types/entities.ts:666

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.PageEntity/index.html b/api/interfaces/headstartwp_core.PageEntity/index.html index 3c8334680..bf0736ffd 100644 --- a/api/interfaces/headstartwp_core.PageEntity/index.html +++ b/api/interfaces/headstartwp_core.PageEntity/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: PageEntity

@headstartwp/core.PageEntity

Interface for entities from the /wp/v2/pages endpoint.

Hierarchy

Properties

_embedded

_embedded: Object

Type declaration

NameType
authorAuthorEntity[]
wp:termTermEntity[][]

Inherited from

PostTypeEntity._embedded

Defined in

packages/core/src/data/types/entities.ts:98


author

Optional author: AuthorEntity[]

Inherited from

PostTypeEntity.author

Defined in

packages/core/src/data/types/entities.ts:94


comment_status

Optional comment_status: "open" | "closed"

Whether or not comments are open on the object.

Inherited from

PostTypeEntity.comment_status

Defined in

packages/core/src/data/types/entities.ts:106


content

content: Rendered

The content for the object.

Defined in

packages/core/src/data/types/entities.ts:209


date

date: string

The date the object was published, in the site's timezone.

Inherited from

PostTypeEntity.date

Defined in

packages/core/src/data/types/entities.ts:42


date_gmt

date_gmt: string

The date the object was published, as GMT.

Inherited from

PostTypeEntity.date_gmt

Defined in

packages/core/src/data/types/entities.ts:47


excerpt

excerpt: Rendered

The excerpt for the object.

Defined in

packages/core/src/data/types/entities.ts:214


featured_media: number

The ID of the featured media for the object.

Defined in

packages/core/src/data/types/entities.ts:234


guid

guid: Rendered

The globally unique identifier for the object.

Inherited from

PostTypeEntity.guid

Defined in

packages/core/src/data/types/entities.ts:52


id

id: number

Unique identifier for the object.

Inherited from

PostTypeEntity.id

Defined in

packages/core/src/data/types/entities.ts:67


link: string

URL to the object.

Inherited from

PostTypeEntity.link

Defined in

packages/core/src/data/types/entities.ts:72


menu_order: number

The order of the object in relation to other object of its type.

Defined in

packages/core/src/data/types/entities.ts:219


meta

meta: Record<string, unknown>

Meta fields.

Defined in

packages/core/src/data/types/entities.ts:224


modified

modified: string

The date the object was last modified, in the site's timezone.

Inherited from

PostTypeEntity.modified

Defined in

packages/core/src/data/types/entities.ts:57


modified_gmt

modified_gmt: string

The date the object was last modified, as GMT.

Inherited from

PostTypeEntity.modified_gmt

Defined in

packages/core/src/data/types/entities.ts:62


parent

parent: number

The ID for the parent of the object.

Defined in

packages/core/src/data/types/entities.ts:204


ping_status

ping_status: "open" | "closed"

Whether or not the object can be pinged.

Inherited from

PostTypeEntity.ping_status

Defined in

packages/core/src/data/types/entities.ts:111


slug

slug: string

An alphanumeric identifier for the object unique to its type.

Inherited from

PostTypeEntity.slug

Defined in

packages/core/src/data/types/entities.ts:77


status

status: "publish" | "future" | "draft" | "pending" | "private"

A named status for the object.

Inherited from

PostTypeEntity.status

Defined in

packages/core/src/data/types/entities.ts:82


template

template: string

The theme file to use to display the object.

Defined in

packages/core/src/data/types/entities.ts:229


terms

Optional terms: Record<string, TermEntity[]>

Inherited from

PostTypeEntity.terms

Defined in

packages/core/src/data/types/entities.ts:96


title

title: Rendered

The title for the object.

Inherited from

PostTypeEntity.title

Defined in

packages/core/src/data/types/entities.ts:92


type

type: string

Type of Post for the object.

Inherited from

PostTypeEntity.type

Defined in

packages/core/src/data/types/entities.ts:87


yoast_head

Optional yoast_head: null | string

Inherited from

PostTypeEntity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:114


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Inherited from

PostTypeEntity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:113

- +
Skip to main content

Interface: PageEntity

@headstartwp/core.PageEntity

Interface for entities from the /wp/v2/pages endpoint.

Hierarchy

Properties

_embedded

_embedded: Object

Type declaration

NameType
authorAuthorEntity[]
wp:termTermEntity[][]

Inherited from

PostTypeEntity._embedded

Defined in

packages/core/src/data/types/entities.ts:98


author

Optional author: AuthorEntity[]

Inherited from

PostTypeEntity.author

Defined in

packages/core/src/data/types/entities.ts:94


comment_status

Optional comment_status: "open" | "closed"

Whether or not comments are open on the object.

Inherited from

PostTypeEntity.comment_status

Defined in

packages/core/src/data/types/entities.ts:106


content

content: Rendered

The content for the object.

Defined in

packages/core/src/data/types/entities.ts:209


date

date: string

The date the object was published, in the site's timezone.

Inherited from

PostTypeEntity.date

Defined in

packages/core/src/data/types/entities.ts:42


date_gmt

date_gmt: string

The date the object was published, as GMT.

Inherited from

PostTypeEntity.date_gmt

Defined in

packages/core/src/data/types/entities.ts:47


excerpt

excerpt: Rendered

The excerpt for the object.

Defined in

packages/core/src/data/types/entities.ts:214


featured_media: number

The ID of the featured media for the object.

Defined in

packages/core/src/data/types/entities.ts:234


guid

guid: Rendered

The globally unique identifier for the object.

Inherited from

PostTypeEntity.guid

Defined in

packages/core/src/data/types/entities.ts:52


id

id: number

Unique identifier for the object.

Inherited from

PostTypeEntity.id

Defined in

packages/core/src/data/types/entities.ts:67


link: string

URL to the object.

Inherited from

PostTypeEntity.link

Defined in

packages/core/src/data/types/entities.ts:72


menu_order: number

The order of the object in relation to other object of its type.

Defined in

packages/core/src/data/types/entities.ts:219


meta

meta: Record<string, unknown>

Meta fields.

Defined in

packages/core/src/data/types/entities.ts:224


modified

modified: string

The date the object was last modified, in the site's timezone.

Inherited from

PostTypeEntity.modified

Defined in

packages/core/src/data/types/entities.ts:57


modified_gmt

modified_gmt: string

The date the object was last modified, as GMT.

Inherited from

PostTypeEntity.modified_gmt

Defined in

packages/core/src/data/types/entities.ts:62


parent

parent: number

The ID for the parent of the object.

Defined in

packages/core/src/data/types/entities.ts:204


ping_status

ping_status: "open" | "closed"

Whether or not the object can be pinged.

Inherited from

PostTypeEntity.ping_status

Defined in

packages/core/src/data/types/entities.ts:111


slug

slug: string

An alphanumeric identifier for the object unique to its type.

Inherited from

PostTypeEntity.slug

Defined in

packages/core/src/data/types/entities.ts:77


status

status: "publish" | "future" | "draft" | "pending" | "private"

A named status for the object.

Inherited from

PostTypeEntity.status

Defined in

packages/core/src/data/types/entities.ts:82


template

template: string

The theme file to use to display the object.

Defined in

packages/core/src/data/types/entities.ts:229


terms

Optional terms: Record<string, TermEntity[]>

Inherited from

PostTypeEntity.terms

Defined in

packages/core/src/data/types/entities.ts:96


title

title: Rendered

The title for the object.

Inherited from

PostTypeEntity.title

Defined in

packages/core/src/data/types/entities.ts:92


type

type: string

Type of Post for the object.

Inherited from

PostTypeEntity.type

Defined in

packages/core/src/data/types/entities.ts:87


yoast_head

Optional yoast_head: null | string

Inherited from

PostTypeEntity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:114


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Inherited from

PostTypeEntity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:113

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.PageInfo/index.html b/api/interfaces/headstartwp_core.PageInfo/index.html index 3d056ea95..897b19ea4 100644 --- a/api/interfaces/headstartwp_core.PageInfo/index.html +++ b/api/interfaces/headstartwp_core.PageInfo/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content
- +
Skip to main content
+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.PolylangIntegration/index.html b/api/interfaces/headstartwp_core.PolylangIntegration/index.html index a5b579745..d224866d0 100644 --- a/api/interfaces/headstartwp_core.PolylangIntegration/index.html +++ b/api/interfaces/headstartwp_core.PolylangIntegration/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content
- +
Skip to main content
+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.PostEntity/index.html b/api/interfaces/headstartwp_core.PostEntity/index.html index f9529b9a3..3ab7a8ada 100644 --- a/api/interfaces/headstartwp_core.PostEntity/index.html +++ b/api/interfaces/headstartwp_core.PostEntity/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: PostEntity

@headstartwp/core.PostEntity

Interface for entities from the /wp/v2/posts endpoint.

Hierarchy

Properties

_embedded

_embedded: Object

Type declaration

NameType
authorAuthorEntity[]
wp:termTermEntity[][]

Inherited from

PostTypeEntity._embedded

Defined in

packages/core/src/data/types/entities.ts:98


author

Optional author: AuthorEntity[]

Inherited from

PostTypeEntity.author

Defined in

packages/core/src/data/types/entities.ts:94


categories

Optional categories: number[]

The terms assigned to the object in the category taxonomy.

Defined in

packages/core/src/data/types/entities.ts:164


comment_status

Optional comment_status: "open" | "closed"

Whether or not comments are open on the object.

Inherited from

PostTypeEntity.comment_status

Defined in

packages/core/src/data/types/entities.ts:106


content

content: Rendered

The content for the object.

Defined in

packages/core/src/data/types/entities.ts:124


date

date: string

The date the object was published, in the site's timezone.

Inherited from

PostTypeEntity.date

Defined in

packages/core/src/data/types/entities.ts:42


date_gmt

date_gmt: string

The date the object was published, as GMT.

Inherited from

PostTypeEntity.date_gmt

Defined in

packages/core/src/data/types/entities.ts:47


excerpt

excerpt: Rendered

The excerpt for the object.

Defined in

packages/core/src/data/types/entities.ts:129


featured_media: number

The ID of the featured media for the object.

Defined in

packages/core/src/data/types/entities.ts:174


format

format: "link" | "status" | "standard" | "aside" | "chat" | "gallery" | "image" | "quote" | "video" | "audio"

The format for the object.

Defined in

packages/core/src/data/types/entities.ts:134


guid

guid: Rendered

The globally unique identifier for the object.

Inherited from

PostTypeEntity.guid

Defined in

packages/core/src/data/types/entities.ts:52


id

id: number

Unique identifier for the object.

Inherited from

PostTypeEntity.id

Defined in

packages/core/src/data/types/entities.ts:67


link: string

URL to the object.

Inherited from

PostTypeEntity.link

Defined in

packages/core/src/data/types/entities.ts:72


meta

meta: Record<string, unknown>

Meta fields.

Defined in

packages/core/src/data/types/entities.ts:149


modified

modified: string

The date the object was last modified, in the site's timezone.

Inherited from

PostTypeEntity.modified

Defined in

packages/core/src/data/types/entities.ts:57


modified_gmt

modified_gmt: string

The date the object was last modified, as GMT.

Inherited from

PostTypeEntity.modified_gmt

Defined in

packages/core/src/data/types/entities.ts:62


ping_status

ping_status: "open" | "closed"

Whether or not the object can be pinged.

Inherited from

PostTypeEntity.ping_status

Defined in

packages/core/src/data/types/entities.ts:111


slug

slug: string

An alphanumeric identifier for the object unique to its type.

Inherited from

PostTypeEntity.slug

Defined in

packages/core/src/data/types/entities.ts:77


status

status: "publish" | "future" | "draft" | "pending" | "private"

A named status for the object.

Inherited from

PostTypeEntity.status

Defined in

packages/core/src/data/types/entities.ts:82


sticky

sticky: boolean

Whether or not the object should be treated as sticky.

Defined in

packages/core/src/data/types/entities.ts:154


tags

Optional tags: number[]

The terms assigned to the object in the post_tag taxonomy.

Defined in

packages/core/src/data/types/entities.ts:169


template

template: string

The theme file to use to display the object.

Defined in

packages/core/src/data/types/entities.ts:159


terms

Optional terms: Record<string, TermEntity[]>

Inherited from

PostTypeEntity.terms

Defined in

packages/core/src/data/types/entities.ts:96


title

title: Rendered

The title for the object.

Inherited from

PostTypeEntity.title

Defined in

packages/core/src/data/types/entities.ts:92


type

type: string

Type of Post for the object.

Inherited from

PostTypeEntity.type

Defined in

packages/core/src/data/types/entities.ts:87


yoast_head

Optional yoast_head: null | string

Inherited from

PostTypeEntity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:114


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Inherited from

PostTypeEntity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:113

- +
Skip to main content

Interface: PostEntity

@headstartwp/core.PostEntity

Interface for entities from the /wp/v2/posts endpoint.

Hierarchy

Properties

_embedded

_embedded: Object

Type declaration

NameType
authorAuthorEntity[]
wp:termTermEntity[][]

Inherited from

PostTypeEntity._embedded

Defined in

packages/core/src/data/types/entities.ts:98


author

Optional author: AuthorEntity[]

Inherited from

PostTypeEntity.author

Defined in

packages/core/src/data/types/entities.ts:94


categories

Optional categories: number[]

The terms assigned to the object in the category taxonomy.

Defined in

packages/core/src/data/types/entities.ts:164


comment_status

Optional comment_status: "open" | "closed"

Whether or not comments are open on the object.

Inherited from

PostTypeEntity.comment_status

Defined in

packages/core/src/data/types/entities.ts:106


content

content: Rendered

The content for the object.

Defined in

packages/core/src/data/types/entities.ts:124


date

date: string

The date the object was published, in the site's timezone.

Inherited from

PostTypeEntity.date

Defined in

packages/core/src/data/types/entities.ts:42


date_gmt

date_gmt: string

The date the object was published, as GMT.

Inherited from

PostTypeEntity.date_gmt

Defined in

packages/core/src/data/types/entities.ts:47


excerpt

excerpt: Rendered

The excerpt for the object.

Defined in

packages/core/src/data/types/entities.ts:129


featured_media: number

The ID of the featured media for the object.

Defined in

packages/core/src/data/types/entities.ts:174


format

format: "link" | "status" | "standard" | "aside" | "chat" | "gallery" | "image" | "quote" | "video" | "audio"

The format for the object.

Defined in

packages/core/src/data/types/entities.ts:134


guid

guid: Rendered

The globally unique identifier for the object.

Inherited from

PostTypeEntity.guid

Defined in

packages/core/src/data/types/entities.ts:52


id

id: number

Unique identifier for the object.

Inherited from

PostTypeEntity.id

Defined in

packages/core/src/data/types/entities.ts:67


link: string

URL to the object.

Inherited from

PostTypeEntity.link

Defined in

packages/core/src/data/types/entities.ts:72


meta

meta: Record<string, unknown>

Meta fields.

Defined in

packages/core/src/data/types/entities.ts:149


modified

modified: string

The date the object was last modified, in the site's timezone.

Inherited from

PostTypeEntity.modified

Defined in

packages/core/src/data/types/entities.ts:57


modified_gmt

modified_gmt: string

The date the object was last modified, as GMT.

Inherited from

PostTypeEntity.modified_gmt

Defined in

packages/core/src/data/types/entities.ts:62


ping_status

ping_status: "open" | "closed"

Whether or not the object can be pinged.

Inherited from

PostTypeEntity.ping_status

Defined in

packages/core/src/data/types/entities.ts:111


slug

slug: string

An alphanumeric identifier for the object unique to its type.

Inherited from

PostTypeEntity.slug

Defined in

packages/core/src/data/types/entities.ts:77


status

status: "publish" | "future" | "draft" | "pending" | "private"

A named status for the object.

Inherited from

PostTypeEntity.status

Defined in

packages/core/src/data/types/entities.ts:82


sticky

sticky: boolean

Whether or not the object should be treated as sticky.

Defined in

packages/core/src/data/types/entities.ts:154


tags

Optional tags: number[]

The terms assigned to the object in the post_tag taxonomy.

Defined in

packages/core/src/data/types/entities.ts:169


template

template: string

The theme file to use to display the object.

Defined in

packages/core/src/data/types/entities.ts:159


terms

Optional terms: Record<string, TermEntity[]>

Inherited from

PostTypeEntity.terms

Defined in

packages/core/src/data/types/entities.ts:96


title

title: Rendered

The title for the object.

Inherited from

PostTypeEntity.title

Defined in

packages/core/src/data/types/entities.ts:92


type

type: string

Type of Post for the object.

Inherited from

PostTypeEntity.type

Defined in

packages/core/src/data/types/entities.ts:87


yoast_head

Optional yoast_head: null | string

Inherited from

PostTypeEntity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:114


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Inherited from

PostTypeEntity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:113

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.PostOrPostsParams/index.html b/api/interfaces/headstartwp_core.PostOrPostsParams/index.html index 1845e5daa..22238c5a1 100644 --- a/api/interfaces/headstartwp_core.PostOrPostsParams/index.html +++ b/api/interfaces/headstartwp_core.PostOrPostsParams/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: PostOrPostsParams

@headstartwp/core.PostOrPostsParams

The params supported by PostOrPostsFetchStrategy

Hierarchy

Properties

_embed

Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Inherited from

EndpointParams._embed

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17


_fields

Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Inherited from

EndpointParams._fields

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22


archive

archive: Partial<PostsArchiveParams>

The archive params corresponds to PostsArchiveParams

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:25


lang

Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Inherited from

EndpointParams.lang

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29


priority

priority: "archive" | "single"

The priority indicates which strategy should execute first.

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:30


routeMatchStrategy

routeMatchStrategy: "none" | "archive" | "single" | "both"

How to handle route matching strategy, the possible values are:

  • single will only trigger the single strategy if there's a url match for the single strategy
  • archive will only trigger the archive strategy if there's a url match for the archive strategy
  • both requires a route match for both single and archive

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:39


single

single: Partial<PostParams>

The single params corresponds to PostParams

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:20

- +
Skip to main content

Interface: PostOrPostsParams

@headstartwp/core.PostOrPostsParams

The params supported by PostOrPostsFetchStrategy

Hierarchy

Properties

_embed

Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Inherited from

EndpointParams._embed

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17


_fields

Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Inherited from

EndpointParams._fields

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22


archive

archive: Partial<PostsArchiveParams>

The archive params corresponds to PostsArchiveParams

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:25


lang

Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Inherited from

EndpointParams.lang

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29


priority

priority: "archive" | "single"

The priority indicates which strategy should execute first.

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:30


routeMatchStrategy

routeMatchStrategy: "none" | "archive" | "single" | "both"

How to handle route matching strategy, the possible values are:

  • single will only trigger the single strategy if there's a url match for the single strategy
  • archive will only trigger the archive strategy if there's a url match for the archive strategy
  • both requires a route match for both single and archive

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:39


single

single: Partial<PostParams>

The single params corresponds to PostParams

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:20

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.PostParams/index.html b/api/interfaces/headstartwp_core.PostParams/index.html index 995876676..25f174f57 100644 --- a/api/interfaces/headstartwp_core.PostParams/index.html +++ b/api/interfaces/headstartwp_core.PostParams/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: PostParams

@headstartwp/core.PostParams

The EndpointParams supported by the SinglePostFetchStrategy

Hierarchy

Properties

_embed

Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Inherited from

EndpointParams._embed

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17


_fields

Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Inherited from

EndpointParams._fields

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22


authToken

Optional authToken: string

The authToken, required to fetch revisions or non-published posts

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:53


fullPath

Optional fullPath: string

If set, this is the path that will be checked if slug is set or matchCurrentPath is set to true.

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:63


id

Optional id: Number

Fetch post by id

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:43


lang

Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Inherited from

EndpointParams.lang

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29


matchCurrentPath

Optional matchCurrentPath: boolean

Whether post.link should be checked against current path

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:58


postType

Optional postType: string | string[]

Post Types where we should look for

If multiple post types are specified -multiple requests will be issued to each post type until a matching post is found

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:38


revision

Optional revision: Boolean

If set will fetch the latest post revision

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:48


slug

Optional slug: string

The slug of the post to fetch

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:30

- +
Skip to main content

Interface: PostParams

@headstartwp/core.PostParams

The EndpointParams supported by the SinglePostFetchStrategy

Hierarchy

Properties

_embed

Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Inherited from

EndpointParams._embed

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17


_fields

Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Inherited from

EndpointParams._fields

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22


authToken

Optional authToken: string

The authToken, required to fetch revisions or non-published posts

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:53


fullPath

Optional fullPath: string

If set, this is the path that will be checked if slug is set or matchCurrentPath is set to true.

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:63


id

Optional id: Number

Fetch post by id

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:43


lang

Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Inherited from

EndpointParams.lang

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29


matchCurrentPath

Optional matchCurrentPath: boolean

Whether post.link should be checked against current path

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:58


postType

Optional postType: string | string[]

Post Types where we should look for

If multiple post types are specified +multiple requests will be issued to each post type until a matching post is found

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:38


revision

Optional revision: Boolean

If set will fetch the latest post revision

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:48


slug

Optional slug: string

The slug of the post to fetch

Defined in

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:30

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.PostTypeEntity/index.html b/api/interfaces/headstartwp_core.PostTypeEntity/index.html index 39ff849e6..9026f9484 100644 --- a/api/interfaces/headstartwp_core.PostTypeEntity/index.html +++ b/api/interfaces/headstartwp_core.PostTypeEntity/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: PostTypeEntity

@headstartwp/core.PostTypeEntity

Base interface for all post type entities.

Interfaces that extends from this one are:

Hierarchy

Properties

_embedded

_embedded: Object

Type declaration

NameType
authorAuthorEntity[]
wp:termTermEntity[][]

Defined in

packages/core/src/data/types/entities.ts:98


author

Optional author: AuthorEntity[]

Defined in

packages/core/src/data/types/entities.ts:94


comment_status

Optional comment_status: "open" | "closed"

Whether or not comments are open on the object.

Defined in

packages/core/src/data/types/entities.ts:106


date

date: string

The date the object was published, in the site's timezone.

Defined in

packages/core/src/data/types/entities.ts:42


date_gmt

date_gmt: string

The date the object was published, as GMT.

Defined in

packages/core/src/data/types/entities.ts:47


guid

guid: Rendered

The globally unique identifier for the object.

Defined in

packages/core/src/data/types/entities.ts:52


id

id: number

Unique identifier for the object.

Defined in

packages/core/src/data/types/entities.ts:67


link: string

URL to the object.

Defined in

packages/core/src/data/types/entities.ts:72


modified

modified: string

The date the object was last modified, in the site's timezone.

Defined in

packages/core/src/data/types/entities.ts:57


modified_gmt

modified_gmt: string

The date the object was last modified, as GMT.

Defined in

packages/core/src/data/types/entities.ts:62


ping_status

ping_status: "open" | "closed"

Whether or not the object can be pinged.

Defined in

packages/core/src/data/types/entities.ts:111


slug

slug: string

An alphanumeric identifier for the object unique to its type.

Defined in

packages/core/src/data/types/entities.ts:77


status

status: "publish" | "future" | "draft" | "pending" | "private"

A named status for the object.

Defined in

packages/core/src/data/types/entities.ts:82


terms

Optional terms: Record<string, TermEntity[]>

Defined in

packages/core/src/data/types/entities.ts:96


title

title: Rendered

The title for the object.

Defined in

packages/core/src/data/types/entities.ts:92


type

type: string

Type of Post for the object.

Defined in

packages/core/src/data/types/entities.ts:87


yoast_head

Optional yoast_head: null | string

Overrides

Entity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:114


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Overrides

Entity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:113

- +
Skip to main content

Interface: PostTypeEntity

@headstartwp/core.PostTypeEntity

Base interface for all post type entities.

Interfaces that extends from this one are:

Hierarchy

Properties

_embedded

_embedded: Object

Type declaration

NameType
authorAuthorEntity[]
wp:termTermEntity[][]

Defined in

packages/core/src/data/types/entities.ts:98


author

Optional author: AuthorEntity[]

Defined in

packages/core/src/data/types/entities.ts:94


comment_status

Optional comment_status: "open" | "closed"

Whether or not comments are open on the object.

Defined in

packages/core/src/data/types/entities.ts:106


date

date: string

The date the object was published, in the site's timezone.

Defined in

packages/core/src/data/types/entities.ts:42


date_gmt

date_gmt: string

The date the object was published, as GMT.

Defined in

packages/core/src/data/types/entities.ts:47


guid

guid: Rendered

The globally unique identifier for the object.

Defined in

packages/core/src/data/types/entities.ts:52


id

id: number

Unique identifier for the object.

Defined in

packages/core/src/data/types/entities.ts:67


link: string

URL to the object.

Defined in

packages/core/src/data/types/entities.ts:72


modified

modified: string

The date the object was last modified, in the site's timezone.

Defined in

packages/core/src/data/types/entities.ts:57


modified_gmt

modified_gmt: string

The date the object was last modified, as GMT.

Defined in

packages/core/src/data/types/entities.ts:62


ping_status

ping_status: "open" | "closed"

Whether or not the object can be pinged.

Defined in

packages/core/src/data/types/entities.ts:111


slug

slug: string

An alphanumeric identifier for the object unique to its type.

Defined in

packages/core/src/data/types/entities.ts:77


status

status: "publish" | "future" | "draft" | "pending" | "private"

A named status for the object.

Defined in

packages/core/src/data/types/entities.ts:82


terms

Optional terms: Record<string, TermEntity[]>

Defined in

packages/core/src/data/types/entities.ts:96


title

title: Rendered

The title for the object.

Defined in

packages/core/src/data/types/entities.ts:92


type

type: string

Type of Post for the object.

Defined in

packages/core/src/data/types/entities.ts:87


yoast_head

Optional yoast_head: null | string

Overrides

Entity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:114


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Overrides

Entity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:113

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.PostsArchiveParams/index.html b/api/interfaces/headstartwp_core.PostsArchiveParams/index.html index 80b568d19..31e477c67 100644 --- a/api/interfaces/headstartwp_core.PostsArchiveParams/index.html +++ b/api/interfaces/headstartwp_core.PostsArchiveParams/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: PostsArchiveParams

@headstartwp/core.PostsArchiveParams

The EndpointParams supported by the PostsArchiveFetchStrategy

Hierarchy

Properties

_embed

Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Inherited from

EndpointParams._embed

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17


_fields

Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Inherited from

EndpointParams._fields

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22


author

Optional author: string | number | number[]

Limit result set to posts assigned to specific authors.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:83


author_exclude

Optional author_exclude: number | number[]

Ensure result set excludes posts assigned to specific authors.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:88


categories

Optional categories: string | number | string[] | number[]

Limit result set to all items that have the specified term assigned in the categories taxonomy.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:156


categories_exclude

Optional categories_exclude: number | number[]

Limit result set to all items except those that have the specified term assigned in the categories taxonomy.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:161


category

Optional category: string | number | number[]

If set will filter results by the specified category name

It supports both a category id and category slug

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:44


day

Optional day: string

If set will filter results by the specified day

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:66


exclude

Optional exclude: number[]

Ensure result set excludes specific IDs.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:93


include

Optional include: number[]

Limit result set to specific IDs.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:98


lang

Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Inherited from

EndpointParams.lang

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29


matchArchivePath

Optional matchArchivePath: boolean

Overrides the value set in CustomTaxonomy#matchArchivePath

Default

false

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:190


month

Optional month: string

If set will filter results by the specified month

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:61


offset

Optional offset: number

Offset the result set by a specific number of items.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:103


order

Optional order: "asc" | "desc"

Order sort attribute ascending or descending.

Default

'desc'

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:110


orderby

Optional orderby: "slug" | "date" | "modified" | "id" | "title" | "author" | "parent" | "include" | "relevance" | "include_slugs"

Sort collection by object attribute.

Default

'date'

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:129


page

Optional page: number

Current page of the collection.

Default

1

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:37


per_page

Optional per_page: number

Maximum number of items to be returned in result set.

Default

10

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:73


postType

Optional postType: string

The post type to query for.

Default

'post'

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:117


Optional search: string

Limit results to those matching a string.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:78


slug

Optional slug: string | string[]

Limit result set to posts with one or more specific slugs.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:122


status

Optional status: string | string[]

Limit result set to posts assigned one or more statuses.

Default

'publish'

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:146


sticky

Optional sticky: boolean

Limit result set to items that are sticky.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:183


tag

Optional tag: string | number

If set will filter results by the specified tag name

It supports both a category id and category slug

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:51


tags

Optional tags: string | number | string[] | number[]

Limit result set to all items that have the specified term assigned in the tags taxonomy.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:173


tags_exclude

Optional tags_exclude: number | number[]

Limit result set to all items except those that have the specified term assigned in the tags taxonomy.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:178


tax_relation

Optional tax_relation: "AND" | "OR"

Limit result set based on relationship between multiple taxonomies.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:151


taxonomy

Optional taxonomy: string

Limit results to a specific taxonomy and expects the actual term slug to come from the url]

If you only specify the taxonomy, the term slug will be assumed to be the first segment of the path

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:168


year

Optional year: string

If set will filter results by the specified year

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:56

- +
Skip to main content

Interface: PostsArchiveParams

@headstartwp/core.PostsArchiveParams

The EndpointParams supported by the PostsArchiveFetchStrategy

Hierarchy

Properties

_embed

Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Inherited from

EndpointParams._embed

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17


_fields

Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Inherited from

EndpointParams._fields

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22


author

Optional author: string | number | number[]

Limit result set to posts assigned to specific authors.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:83


author_exclude

Optional author_exclude: number | number[]

Ensure result set excludes posts assigned to specific authors.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:88


categories

Optional categories: string | number | string[] | number[]

Limit result set to all items that have the specified term assigned in the categories taxonomy.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:156


categories_exclude

Optional categories_exclude: number | number[]

Limit result set to all items except those that have the specified term assigned in the categories taxonomy.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:161


category

Optional category: string | number | number[]

If set will filter results by the specified category name

It supports both a category id and category slug

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:44


day

Optional day: string

If set will filter results by the specified day

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:66


exclude

Optional exclude: number[]

Ensure result set excludes specific IDs.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:93


include

Optional include: number[]

Limit result set to specific IDs.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:98


lang

Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Inherited from

EndpointParams.lang

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29


matchArchivePath

Optional matchArchivePath: boolean

Overrides the value set in CustomTaxonomy#matchArchivePath

Default

false

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:190


month

Optional month: string

If set will filter results by the specified month

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:61


offset

Optional offset: number

Offset the result set by a specific number of items.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:103


order

Optional order: "asc" | "desc"

Order sort attribute ascending or descending.

Default

'desc'

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:110


orderby

Optional orderby: "slug" | "date" | "modified" | "id" | "title" | "author" | "parent" | "include" | "relevance" | "include_slugs"

Sort collection by object attribute.

Default

'date'

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:129


page

Optional page: number

Current page of the collection.

Default

1

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:37


per_page

Optional per_page: number

Maximum number of items to be returned in result set.

Default

10

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:73


postType

Optional postType: string

The post type to query for.

Default

'post'

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:117


Optional search: string

Limit results to those matching a string.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:78


slug

Optional slug: string | string[]

Limit result set to posts with one or more specific slugs.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:122


status

Optional status: string | string[]

Limit result set to posts assigned one or more statuses.

Default

'publish'

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:146


sticky

Optional sticky: boolean

Limit result set to items that are sticky.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:183


tag

Optional tag: string | number

If set will filter results by the specified tag name

It supports both a category id and category slug

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:51


tags

Optional tags: string | number | string[] | number[]

Limit result set to all items that have the specified term assigned in the tags taxonomy.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:173


tags_exclude

Optional tags_exclude: number | number[]

Limit result set to all items except those that have the specified term assigned in the tags taxonomy.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:178


tax_relation

Optional tax_relation: "AND" | "OR"

Limit result set based on relationship between multiple taxonomies.

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:151


taxonomy

Optional taxonomy: string

Limit results to a specific taxonomy and expects the actual term slug to come from the url]

If you only specify the taxonomy, the term slug will be assumed to be the first segment of the path

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:168


year

Optional year: string

If set will filter results by the specified year

Defined in

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:56

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.Rendered/index.html b/api/interfaces/headstartwp_core.Rendered/index.html index 5700daff0..07ba985ee 100644 --- a/api/interfaces/headstartwp_core.Rendered/index.html +++ b/api/interfaces/headstartwp_core.Rendered/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content
- +
Skip to main content
+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.RevisionEntity/index.html b/api/interfaces/headstartwp_core.RevisionEntity/index.html index 93ea22d32..ef2ddae6d 100644 --- a/api/interfaces/headstartwp_core.RevisionEntity/index.html +++ b/api/interfaces/headstartwp_core.RevisionEntity/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: RevisionEntity

@headstartwp/core.RevisionEntity

Interface for entities from the /wp/v2/posts/1/revisions endpoint.

Hierarchy

Properties

_embedded

_embedded: Object

Type declaration

NameType
authorAuthorEntity[]
wp:termTermEntity[][]

Inherited from

PostTypeEntity._embedded

Defined in

packages/core/src/data/types/entities.ts:98


author

Optional author: AuthorEntity[]

Inherited from

PostTypeEntity.author

Defined in

packages/core/src/data/types/entities.ts:94


comment_status

Optional comment_status: "open" | "closed"

Whether or not comments are open on the object.

Inherited from

PostTypeEntity.comment_status

Defined in

packages/core/src/data/types/entities.ts:106


content

Optional content: Rendered

The content for the object.

Defined in

packages/core/src/data/types/entities.ts:189


date

date: string

The date the object was published, in the site's timezone.

Inherited from

PostTypeEntity.date

Defined in

packages/core/src/data/types/entities.ts:42


date_gmt

date_gmt: string

The date the object was published, as GMT.

Inherited from

PostTypeEntity.date_gmt

Defined in

packages/core/src/data/types/entities.ts:47


excerpt

Optional excerpt: Rendered

The excerpt for the object.

Defined in

packages/core/src/data/types/entities.ts:194


guid

guid: Rendered

The globally unique identifier for the object.

Inherited from

PostTypeEntity.guid

Defined in

packages/core/src/data/types/entities.ts:52


id

id: number

Unique identifier for the object.

Inherited from

PostTypeEntity.id

Defined in

packages/core/src/data/types/entities.ts:67


link: string

URL to the object.

Inherited from

PostTypeEntity.link

Defined in

packages/core/src/data/types/entities.ts:72


modified

modified: string

The date the object was last modified, in the site's timezone.

Inherited from

PostTypeEntity.modified

Defined in

packages/core/src/data/types/entities.ts:57


modified_gmt

modified_gmt: string

The date the object was last modified, as GMT.

Inherited from

PostTypeEntity.modified_gmt

Defined in

packages/core/src/data/types/entities.ts:62


parent

Optional parent: number

The ID for the parent of the object.

Defined in

packages/core/src/data/types/entities.ts:184


ping_status

ping_status: "open" | "closed"

Whether or not the object can be pinged.

Inherited from

PostTypeEntity.ping_status

Defined in

packages/core/src/data/types/entities.ts:111


slug

slug: string

An alphanumeric identifier for the object unique to its type.

Inherited from

PostTypeEntity.slug

Defined in

packages/core/src/data/types/entities.ts:77


status

status: "publish" | "future" | "draft" | "pending" | "private"

A named status for the object.

Inherited from

PostTypeEntity.status

Defined in

packages/core/src/data/types/entities.ts:82


terms

Optional terms: Record<string, TermEntity[]>

Inherited from

PostTypeEntity.terms

Defined in

packages/core/src/data/types/entities.ts:96


title

title: Rendered

The title for the object.

Inherited from

PostTypeEntity.title

Defined in

packages/core/src/data/types/entities.ts:92


type

type: string

Type of Post for the object.

Inherited from

PostTypeEntity.type

Defined in

packages/core/src/data/types/entities.ts:87


yoast_head

Optional yoast_head: null | string

Inherited from

PostTypeEntity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:114


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Inherited from

PostTypeEntity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:113

- +
Skip to main content

Interface: RevisionEntity

@headstartwp/core.RevisionEntity

Interface for entities from the /wp/v2/posts/1/revisions endpoint.

Hierarchy

Properties

_embedded

_embedded: Object

Type declaration

NameType
authorAuthorEntity[]
wp:termTermEntity[][]

Inherited from

PostTypeEntity._embedded

Defined in

packages/core/src/data/types/entities.ts:98


author

Optional author: AuthorEntity[]

Inherited from

PostTypeEntity.author

Defined in

packages/core/src/data/types/entities.ts:94


comment_status

Optional comment_status: "open" | "closed"

Whether or not comments are open on the object.

Inherited from

PostTypeEntity.comment_status

Defined in

packages/core/src/data/types/entities.ts:106


content

Optional content: Rendered

The content for the object.

Defined in

packages/core/src/data/types/entities.ts:189


date

date: string

The date the object was published, in the site's timezone.

Inherited from

PostTypeEntity.date

Defined in

packages/core/src/data/types/entities.ts:42


date_gmt

date_gmt: string

The date the object was published, as GMT.

Inherited from

PostTypeEntity.date_gmt

Defined in

packages/core/src/data/types/entities.ts:47


excerpt

Optional excerpt: Rendered

The excerpt for the object.

Defined in

packages/core/src/data/types/entities.ts:194


guid

guid: Rendered

The globally unique identifier for the object.

Inherited from

PostTypeEntity.guid

Defined in

packages/core/src/data/types/entities.ts:52


id

id: number

Unique identifier for the object.

Inherited from

PostTypeEntity.id

Defined in

packages/core/src/data/types/entities.ts:67


link: string

URL to the object.

Inherited from

PostTypeEntity.link

Defined in

packages/core/src/data/types/entities.ts:72


modified

modified: string

The date the object was last modified, in the site's timezone.

Inherited from

PostTypeEntity.modified

Defined in

packages/core/src/data/types/entities.ts:57


modified_gmt

modified_gmt: string

The date the object was last modified, as GMT.

Inherited from

PostTypeEntity.modified_gmt

Defined in

packages/core/src/data/types/entities.ts:62


parent

Optional parent: number

The ID for the parent of the object.

Defined in

packages/core/src/data/types/entities.ts:184


ping_status

ping_status: "open" | "closed"

Whether or not the object can be pinged.

Inherited from

PostTypeEntity.ping_status

Defined in

packages/core/src/data/types/entities.ts:111


slug

slug: string

An alphanumeric identifier for the object unique to its type.

Inherited from

PostTypeEntity.slug

Defined in

packages/core/src/data/types/entities.ts:77


status

status: "publish" | "future" | "draft" | "pending" | "private"

A named status for the object.

Inherited from

PostTypeEntity.status

Defined in

packages/core/src/data/types/entities.ts:82


terms

Optional terms: Record<string, TermEntity[]>

Inherited from

PostTypeEntity.terms

Defined in

packages/core/src/data/types/entities.ts:96


title

title: Rendered

The title for the object.

Inherited from

PostTypeEntity.title

Defined in

packages/core/src/data/types/entities.ts:92


type

type: string

Type of Post for the object.

Inherited from

PostTypeEntity.type

Defined in

packages/core/src/data/types/entities.ts:87


yoast_head

Optional yoast_head: null | string

Inherited from

PostTypeEntity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:114


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Inherited from

PostTypeEntity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:113

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.SearchEntity/index.html b/api/interfaces/headstartwp_core.SearchEntity/index.html index 31c1f894c..2ac218208 100644 --- a/api/interfaces/headstartwp_core.SearchEntity/index.html +++ b/api/interfaces/headstartwp_core.SearchEntity/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: SearchEntity

@headstartwp/core.SearchEntity

Interface for entities from the /wp/v2/search endpoint.

Hierarchy

Properties

searchedValue

searchedValue: string

Defined in

packages/core/src/data/types/entities.ts:634


subtype

subtype: string

Subtype of Search for the object.

Defined in

packages/core/src/data/types/entities.ts:644


type

type: string

Type of Search for the object.

Defined in

packages/core/src/data/types/entities.ts:639


yoast_head

Optional yoast_head: null | string

Inherited from

Entity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:14


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Inherited from

Entity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:13

- +
Skip to main content

Interface: SearchEntity

@headstartwp/core.SearchEntity

Interface for entities from the /wp/v2/search endpoint.

Hierarchy

Properties

searchedValue

searchedValue: string

Defined in

packages/core/src/data/types/entities.ts:634


subtype

subtype: string

Subtype of Search for the object.

Defined in

packages/core/src/data/types/entities.ts:644


type

type: string

Type of Search for the object.

Defined in

packages/core/src/data/types/entities.ts:639


yoast_head

Optional yoast_head: null | string

Inherited from

Entity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:14


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Inherited from

Entity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:13

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.TaxonomyArchiveParams/index.html b/api/interfaces/headstartwp_core.TaxonomyArchiveParams/index.html index dbe8ef879..54dcbc7af 100644 --- a/api/interfaces/headstartwp_core.TaxonomyArchiveParams/index.html +++ b/api/interfaces/headstartwp_core.TaxonomyArchiveParams/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: TaxonomyArchiveParams

@headstartwp/core.TaxonomyArchiveParams

The endpoint params supported by TaxonomyTermsStrategy

Hierarchy

Properties

_embed

Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Inherited from

EndpointParams._embed

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17


_fields

Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Inherited from

EndpointParams._fields

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22


exclude

Optional exclude: number | number[]

Ensure result set excludes specific IDs.

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:49


hide_empty

Optional hide_empty: string

Whether to hide terms not assigned to any posts.

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:76


include

Optional include: number | number[]

Limit result set to specific IDs.

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:44


lang

Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Inherited from

EndpointParams.lang

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29


order

Optional order: "asc" | "desc"

Order sort attribute ascending or descending.

Default

'asc'

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:56


orderby

Optional orderby: "slug" | "id" | "description" | "name" | "count" | "include" | "include_slugs" | "term_group"

Sort collection by term attribute.

Default

'name'

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:63


page

Optional page: string

Current page of the collection.

Default

1

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:27


parent

Optional parent: number

Limit result set to terms assigned to a specific parent.

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:81


per_page

Optional per_page: string

Maximum number of items to be returned in result set.

Default

10

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:34


post

Optional post: number

Limit result set to terms assigned to a specific post.

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:86


Optional search: string

Limit results to those matching a string

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:39


slug

Optional slug: string | string[]

Limit result set to terms with one or more specific slugs.

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:91


taxonomy

Optional taxonomy: string

The taxonomy the terms are to be fetched from.

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:20

- +
Skip to main content

Interface: TaxonomyArchiveParams

@headstartwp/core.TaxonomyArchiveParams

The endpoint params supported by TaxonomyTermsStrategy

Hierarchy

Properties

_embed

Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Inherited from

EndpointParams._embed

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17


_fields

Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Inherited from

EndpointParams._fields

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22


exclude

Optional exclude: number | number[]

Ensure result set excludes specific IDs.

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:49


hide_empty

Optional hide_empty: string

Whether to hide terms not assigned to any posts.

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:76


include

Optional include: number | number[]

Limit result set to specific IDs.

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:44


lang

Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Inherited from

EndpointParams.lang

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29


order

Optional order: "asc" | "desc"

Order sort attribute ascending or descending.

Default

'asc'

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:56


orderby

Optional orderby: "slug" | "id" | "description" | "name" | "count" | "include" | "include_slugs" | "term_group"

Sort collection by term attribute.

Default

'name'

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:63


page

Optional page: string

Current page of the collection.

Default

1

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:27


parent

Optional parent: number

Limit result set to terms assigned to a specific parent.

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:81


per_page

Optional per_page: string

Maximum number of items to be returned in result set.

Default

10

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:34


post

Optional post: number

Limit result set to terms assigned to a specific post.

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:86


Optional search: string

Limit results to those matching a string

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:39


slug

Optional slug: string | string[]

Limit result set to terms with one or more specific slugs.

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:91


taxonomy

Optional taxonomy: string

The taxonomy the terms are to be fetched from.

Defined in

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:20

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.TaxonomyEntity/index.html b/api/interfaces/headstartwp_core.TaxonomyEntity/index.html index b0c7591c7..9e0083755 100644 --- a/api/interfaces/headstartwp_core.TaxonomyEntity/index.html +++ b/api/interfaces/headstartwp_core.TaxonomyEntity/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: TaxonomyEntity

@headstartwp/core.TaxonomyEntity

Interface for entities from the /wp/v2/taxonomy endpoint.

Hierarchy

Properties

description

description: string

A human-readable description of the taxonomy.

Defined in

packages/core/src/data/types/entities.ts:397


hierarchical

hierarchical: boolean

Whether or not the taxonomy should have children.

Defined in

packages/core/src/data/types/entities.ts:402


name

name: string

The title for the taxonomy.

Defined in

packages/core/src/data/types/entities.ts:407


rest_base

rest_base: string

REST base route for the taxonomy.

Defined in

packages/core/src/data/types/entities.ts:417


slug

slug: string

An alphanumeric identifier for the taxonomy.

Defined in

packages/core/src/data/types/entities.ts:412


types

types: string[]

Types associated with the taxonomy.

Defined in

packages/core/src/data/types/entities.ts:422


yoast_head

Optional yoast_head: null | string

Inherited from

Entity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:14


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Inherited from

Entity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:13

- +
Skip to main content

Interface: TaxonomyEntity

@headstartwp/core.TaxonomyEntity

Interface for entities from the /wp/v2/taxonomy endpoint.

Hierarchy

Properties

description

description: string

A human-readable description of the taxonomy.

Defined in

packages/core/src/data/types/entities.ts:397


hierarchical

hierarchical: boolean

Whether or not the taxonomy should have children.

Defined in

packages/core/src/data/types/entities.ts:402


name

name: string

The title for the taxonomy.

Defined in

packages/core/src/data/types/entities.ts:407


rest_base

rest_base: string

REST base route for the taxonomy.

Defined in

packages/core/src/data/types/entities.ts:417


slug

slug: string

An alphanumeric identifier for the taxonomy.

Defined in

packages/core/src/data/types/entities.ts:412


types

types: string[]

Types associated with the taxonomy.

Defined in

packages/core/src/data/types/entities.ts:422


yoast_head

Optional yoast_head: null | string

Inherited from

Entity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:14


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Inherited from

Entity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:13

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.TermEntity/index.html b/api/interfaces/headstartwp_core.TermEntity/index.html index d7797bd14..6c623310d 100644 --- a/api/interfaces/headstartwp_core.TermEntity/index.html +++ b/api/interfaces/headstartwp_core.TermEntity/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: TermEntity

@headstartwp/core.TermEntity

Interface for entities that belong to a taxonomy.

For example:

  • entities from the /wp/v2/categories endpoint.
  • entities from the /wp/v2/tags endpoint.

Hierarchy

Properties

count

count: number

Number of published posts for the term.

Defined in

packages/core/src/data/types/entities.ts:441


description

description: string

HTML description of the term.

Defined in

packages/core/src/data/types/entities.ts:446


id

id: number

Unique identifier for the term.

Defined in

packages/core/src/data/types/entities.ts:436


link: string

URL of the term.

Defined in

packages/core/src/data/types/entities.ts:451


meta

meta: Record<string, unknown>

Meta fields.

Defined in

packages/core/src/data/types/entities.ts:476


name

name: string

HTML title for the term.

Defined in

packages/core/src/data/types/entities.ts:456


parent

parent: number

The parent term ID.

Defined in

packages/core/src/data/types/entities.ts:471


slug

slug: string

An alphanumeric identifier for the term unique to its type.

Defined in

packages/core/src/data/types/entities.ts:461


taxonomy

taxonomy: string

Type attribution for the term.

Defined in

packages/core/src/data/types/entities.ts:466


yoast_head

Optional yoast_head: null | string

Overrides

Entity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:479


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Overrides

Entity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:478

- +
Skip to main content

Interface: TermEntity

@headstartwp/core.TermEntity

Interface for entities that belong to a taxonomy.

For example:

  • entities from the /wp/v2/categories endpoint.
  • entities from the /wp/v2/tags endpoint.

Hierarchy

Properties

count

count: number

Number of published posts for the term.

Defined in

packages/core/src/data/types/entities.ts:441


description

description: string

HTML description of the term.

Defined in

packages/core/src/data/types/entities.ts:446


id

id: number

Unique identifier for the term.

Defined in

packages/core/src/data/types/entities.ts:436


link: string

URL of the term.

Defined in

packages/core/src/data/types/entities.ts:451


meta

meta: Record<string, unknown>

Meta fields.

Defined in

packages/core/src/data/types/entities.ts:476


name

name: string

HTML title for the term.

Defined in

packages/core/src/data/types/entities.ts:456


parent

parent: number

The parent term ID.

Defined in

packages/core/src/data/types/entities.ts:471


slug

slug: string

An alphanumeric identifier for the term unique to its type.

Defined in

packages/core/src/data/types/entities.ts:461


taxonomy

taxonomy: string

Type attribution for the term.

Defined in

packages/core/src/data/types/entities.ts:466


yoast_head

Optional yoast_head: null | string

Overrides

Entity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:479


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Overrides

Entity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:478

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.TypeEntity/index.html b/api/interfaces/headstartwp_core.TypeEntity/index.html index 66f91b2ef..7ffa0e7bb 100644 --- a/api/interfaces/headstartwp_core.TypeEntity/index.html +++ b/api/interfaces/headstartwp_core.TypeEntity/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: TypeEntity

@headstartwp/core.TypeEntity

Interface for entities from the /wp/v2/types endpoint.

Hierarchy

Properties

description

Optional description: string

A human-readable description of the post type.

Defined in

packages/core/src/data/types/entities.ts:362


hierarchical

Optional hierarchical: boolean

Whether or not the post type should have children.

Defined in

packages/core/src/data/types/entities.ts:367


name

Optional name: string

The title for the post type.

Defined in

packages/core/src/data/types/entities.ts:372


rest_base

rest_base: string

REST base route for the post type.

Defined in

packages/core/src/data/types/entities.ts:382


slug

Optional slug: string

An alphanumeric identifier for the post type.

Defined in

packages/core/src/data/types/entities.ts:377


taxonomies

taxonomies: string[]

Taxonomies associated with post type.

Defined in

packages/core/src/data/types/entities.ts:387


yoast_head

Optional yoast_head: null | string

Inherited from

Entity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:14


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Inherited from

Entity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:13

- +
Skip to main content

Interface: TypeEntity

@headstartwp/core.TypeEntity

Interface for entities from the /wp/v2/types endpoint.

Hierarchy

Properties

description

Optional description: string

A human-readable description of the post type.

Defined in

packages/core/src/data/types/entities.ts:362


hierarchical

Optional hierarchical: boolean

Whether or not the post type should have children.

Defined in

packages/core/src/data/types/entities.ts:367


name

Optional name: string

The title for the post type.

Defined in

packages/core/src/data/types/entities.ts:372


rest_base

rest_base: string

REST base route for the post type.

Defined in

packages/core/src/data/types/entities.ts:382


slug

Optional slug: string

An alphanumeric identifier for the post type.

Defined in

packages/core/src/data/types/entities.ts:377


taxonomies

taxonomies: string[]

Taxonomies associated with post type.

Defined in

packages/core/src/data/types/entities.ts:387


yoast_head

Optional yoast_head: null | string

Inherited from

Entity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:14


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Inherited from

Entity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:13

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.VerifyTokenParams/index.html b/api/interfaces/headstartwp_core.VerifyTokenParams/index.html index 257c104d8..1006b39b5 100644 --- a/api/interfaces/headstartwp_core.VerifyTokenParams/index.html +++ b/api/interfaces/headstartwp_core.VerifyTokenParams/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: VerifyTokenParams

@headstartwp/core.VerifyTokenParams

The EndpointParams supported by the VerifyTokenFetchStrategy

Hierarchy

Properties

_embed

Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Inherited from

EndpointParams._embed

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17


_fields

Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Inherited from

EndpointParams._fields

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22


authToken

Optional authToken: string

Defined in

packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:9


lang

Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Inherited from

EndpointParams.lang

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29

- +
Skip to main content

Interface: VerifyTokenParams

@headstartwp/core.VerifyTokenParams

The EndpointParams supported by the VerifyTokenFetchStrategy

Hierarchy

Properties

_embed

Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Inherited from

EndpointParams._embed

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17


_fields

Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Inherited from

EndpointParams._fields

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22


authToken

Optional authToken: string

Defined in

packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:9


lang

Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Inherited from

EndpointParams.lang

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.YoastSEOIntegration/index.html b/api/interfaces/headstartwp_core.YoastSEOIntegration/index.html index 4f25c030e..717a91325 100644 --- a/api/interfaces/headstartwp_core.YoastSEOIntegration/index.html +++ b/api/interfaces/headstartwp_core.YoastSEOIntegration/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content
- +
Skip to main content
+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.AudioBlockProps/index.html b/api/interfaces/headstartwp_core.react.AudioBlockProps/index.html index 67fd7759e..a9f37111c 100644 --- a/api/interfaces/headstartwp_core.react.AudioBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.AudioBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: AudioBlockProps

@headstartwp/core.react.AudioBlockProps

The interface for components rendered by AudioBlock

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


autoplay

Optional autoplay: boolean

Whether the audio should be autoplayable

Defined in

packages/core/src/react/blocks/AudioBlock.tsx:19


caption

Optional caption: string

Audio caption

Defined in

packages/core/src/react/blocks/AudioBlock.tsx:24


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


loop

Optional loop: boolean

Whether the audio should be played in a loop

Defined in

packages/core/src/react/blocks/AudioBlock.tsx:29


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


preload

Optional preload: string

Whether to preload the audio or not

Defined in

packages/core/src/react/blocks/AudioBlock.tsx:34


src

src: string

The audio source URL.

Defined in

packages/core/src/react/blocks/AudioBlock.tsx:14


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

- +
Skip to main content

Interface: AudioBlockProps

@headstartwp/core.react.AudioBlockProps

The interface for components rendered by AudioBlock

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


autoplay

Optional autoplay: boolean

Whether the audio should be autoplayable

Defined in

packages/core/src/react/blocks/AudioBlock.tsx:19


caption

Optional caption: string

Audio caption

Defined in

packages/core/src/react/blocks/AudioBlock.tsx:24


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


loop

Optional loop: boolean

Whether the audio should be played in a loop

Defined in

packages/core/src/react/blocks/AudioBlock.tsx:29


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


preload

Optional preload: string

Whether to preload the audio or not

Defined in

packages/core/src/react/blocks/AudioBlock.tsx:34


src

src: string

The audio source URL.

Defined in

packages/core/src/react/blocks/AudioBlock.tsx:14


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.BlockAttributes/index.html b/api/interfaces/headstartwp_core.react.BlockAttributes/index.html index 551f3ea94..edffd9784 100644 --- a/api/interfaces/headstartwp_core.react.BlockAttributes/index.html +++ b/api/interfaces/headstartwp_core.react.BlockAttributes/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: BlockAttributes

@headstartwp/core.react.BlockAttributes

Hierarchy

Properties

align

align: Align

Defined in

packages/core/src/react/blocks/types.ts:95


backgroundColor

backgroundColor: string

Inherited from

Colors.backgroundColor

Defined in

packages/core/src/react/blocks/types.ts:6


backgroundColorSlug

backgroundColorSlug: string

Inherited from

Colors.backgroundColorSlug

Defined in

packages/core/src/react/blocks/types.ts:5


gradient

gradient: string

Inherited from

Colors.gradient

Defined in

packages/core/src/react/blocks/types.ts:8


gradientSlug

gradientSlug: string

Inherited from

Colors.gradientSlug

Defined in

packages/core/src/react/blocks/types.ts:7


linkColor

linkColor: string

Inherited from

Colors.linkColor

Defined in

packages/core/src/react/blocks/types.ts:12


linkColorSlug

linkColorSlug: string

Inherited from

Colors.linkColorSlug

Defined in

packages/core/src/react/blocks/types.ts:11


style

style: Partial<Style>

Defined in

packages/core/src/react/blocks/types.ts:96


textColor

textColor: string

Inherited from

Colors.textColor

Defined in

packages/core/src/react/blocks/types.ts:10


textColorSlug

textColorSlug: string

Inherited from

Colors.textColorSlug

Defined in

packages/core/src/react/blocks/types.ts:9


typography

typography: Typography

Defined in

packages/core/src/react/blocks/types.ts:98


width

width: string

Defined in

packages/core/src/react/blocks/types.ts:97

- +
Skip to main content

Interface: BlockAttributes

@headstartwp/core.react.BlockAttributes

Hierarchy

Properties

align

align: Align

Defined in

packages/core/src/react/blocks/types.ts:95


backgroundColor

backgroundColor: string

Inherited from

Colors.backgroundColor

Defined in

packages/core/src/react/blocks/types.ts:6


backgroundColorSlug

backgroundColorSlug: string

Inherited from

Colors.backgroundColorSlug

Defined in

packages/core/src/react/blocks/types.ts:5


gradient

gradient: string

Inherited from

Colors.gradient

Defined in

packages/core/src/react/blocks/types.ts:8


gradientSlug

gradientSlug: string

Inherited from

Colors.gradientSlug

Defined in

packages/core/src/react/blocks/types.ts:7


linkColor

linkColor: string

Inherited from

Colors.linkColor

Defined in

packages/core/src/react/blocks/types.ts:12


linkColorSlug

linkColorSlug: string

Inherited from

Colors.linkColorSlug

Defined in

packages/core/src/react/blocks/types.ts:11


style

style: Partial<Style>

Defined in

packages/core/src/react/blocks/types.ts:96


textColor

textColor: string

Inherited from

Colors.textColor

Defined in

packages/core/src/react/blocks/types.ts:10


textColorSlug

textColorSlug: string

Inherited from

Colors.textColorSlug

Defined in

packages/core/src/react/blocks/types.ts:9


typography

typography: Typography

Defined in

packages/core/src/react/blocks/types.ts:98


width

width: string

Defined in

packages/core/src/react/blocks/types.ts:97

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.BlockProps/index.html b/api/interfaces/headstartwp_core.react.BlockProps/index.html index 1e5e83e8e..55bfbd0af 100644 --- a/api/interfaces/headstartwp_core.react.BlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.BlockProps/index.html @@ -7,15 +7,15 @@ - +
-
Skip to main content

Interface: BlockProps

@headstartwp/core.react.BlockProps

The interface any children of BlocksRenderer must implement.

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


domNode

Optional domNode: Element

The actual domNode that was replaced with the react component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:46


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34


test

Optional test: (domNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (domNode, site?): boolean

A test function receives a domNode and returns a boolean value indicating -whether that domNode should be replaced with the React component

Parameters
NameType
domNodeElement
site?HeadlessConfig
Returns

boolean

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:19

- +
Skip to main content

Interface: BlockProps

@headstartwp/core.react.BlockProps

The interface any children of BlocksRenderer must implement.

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


domNode

Optional domNode: Element

The actual domNode that was replaced with the react component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:46


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34


test

Optional test: (domNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (domNode, site?): boolean

A test function receives a domNode and returns a boolean value indicating +whether that domNode should be replaced with the React component

Parameters
NameType
domNodeElement
site?HeadlessConfig
Returns

boolean

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:19

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.BlockRendererProps/index.html b/api/interfaces/headstartwp_core.react.BlockRendererProps/index.html index 419c6cf31..9ae50a430 100644 --- a/api/interfaces/headstartwp_core.react.BlockRendererProps/index.html +++ b/api/interfaces/headstartwp_core.react.BlockRendererProps/index.html @@ -7,14 +7,14 @@ - +
Skip to main content

Interface: BlockRendererProps

@headstartwp/core.react.BlockRendererProps

The type definition for the BlocksRenderer component.

Properties

children

Optional children: ReactNode

The children components that must implements BlockProps. Failing to implement BlockProps -will issue a warning at runtime.

Passing children are not mandatory, if you do not pass them BlocksRenderer will simply sanitize the html markup.

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:110


html

html: string

The HTML string to be parsed.

<BlocksRenderer
html="<div><p>hello world</p> div content</div>"
/>,

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:83


ksesAllowList

Optional ksesAllowList: IWhiteList

The allow list for the parser

<BlocksRenderer
html="<div><p>hello world</p> div content</div>"
ksesAllowList={{ div: [] }}
/>,

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:95


sanitizeFn

Optional sanitizeFn: (html: string, ksesAllowList?: IWhiteList) => string

Type declaration

▸ (html, ksesAllowList?): string

A custom implementation of the sanitize function.

If none is provided it's going to default to wpKsesPost

Parameters
NameType
htmlstring
ksesAllowList?IWhiteList
Returns

string

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:102

- +will issue a warning at runtime.

Passing children are not mandatory, if you do not pass them BlocksRenderer will simply sanitize the html markup.

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:110


html

html: string

The HTML string to be parsed.

<BlocksRenderer
html="<div><p>hello world</p> div content</div>"
/>,

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:83


ksesAllowList

Optional ksesAllowList: IWhiteList

The allow list for the parser

<BlocksRenderer
html="<div><p>hello world</p> div content</div>"
ksesAllowList={{ div: [] }}
/>,

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:95


sanitizeFn

Optional sanitizeFn: (html: string, ksesAllowList?: IWhiteList) => string

Type declaration

▸ (html, ksesAllowList?): string

A custom implementation of the sanitize function.

If none is provided it's going to default to wpKsesPost

Parameters
NameType
htmlstring
ksesAllowList?IWhiteList
Returns

string

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:102

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ButtonBlockProps/index.html b/api/interfaces/headstartwp_core.react.ButtonBlockProps/index.html index 7ef150469..552e40e64 100644 --- a/api/interfaces/headstartwp_core.react.ButtonBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.ButtonBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: ButtonBlockProps

@headstartwp/core.react.ButtonBlockProps

The interface for components rendered by ButtonBlock

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


linkTarget

Optional linkTarget: string

The link target

Defined in

packages/core/src/react/blocks/ButtonBlock.tsx:31


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


placeholder

Optional placeholder: string

The link placeholder text

Defined in

packages/core/src/react/blocks/ButtonBlock.tsx:41


rel

Optional rel: string

The link rel

Defined in

packages/core/src/react/blocks/ButtonBlock.tsx:36


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74


text

Optional text: string

The button text

Defined in

packages/core/src/react/blocks/ButtonBlock.tsx:26


title

Optional title: string

The title of the link

Defined in

packages/core/src/react/blocks/ButtonBlock.tsx:21


url

Optional url: string

The button url

Defined in

packages/core/src/react/blocks/ButtonBlock.tsx:16

- +
Skip to main content

Interface: ButtonBlockProps

@headstartwp/core.react.ButtonBlockProps

The interface for components rendered by ButtonBlock

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


linkTarget

Optional linkTarget: string

The link target

Defined in

packages/core/src/react/blocks/ButtonBlock.tsx:31


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


placeholder

Optional placeholder: string

The link placeholder text

Defined in

packages/core/src/react/blocks/ButtonBlock.tsx:41


rel

Optional rel: string

The link rel

Defined in

packages/core/src/react/blocks/ButtonBlock.tsx:36


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74


text

Optional text: string

The button text

Defined in

packages/core/src/react/blocks/ButtonBlock.tsx:26


title

Optional title: string

The title of the link

Defined in

packages/core/src/react/blocks/ButtonBlock.tsx:21


url

Optional url: string

The button url

Defined in

packages/core/src/react/blocks/ButtonBlock.tsx:16

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ButtonsBlockProps/index.html b/api/interfaces/headstartwp_core.react.ButtonsBlockProps/index.html index 00b6b6342..1c8a25ef1 100644 --- a/api/interfaces/headstartwp_core.react.ButtonsBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.ButtonsBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: ButtonsBlockProps

@headstartwp/core.react.ButtonsBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

- +
Skip to main content

Interface: ButtonsBlockProps

@headstartwp/core.react.ButtonsBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.CodeBlockProps/index.html b/api/interfaces/headstartwp_core.react.CodeBlockProps/index.html index 0dee55db2..681838762 100644 --- a/api/interfaces/headstartwp_core.react.CodeBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.CodeBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: CodeBlockProps

@headstartwp/core.react.CodeBlockProps

The interface for components rendered by CodeBlock

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

- +
Skip to main content

Interface: CodeBlockProps

@headstartwp/core.react.CodeBlockProps

The interface for components rendered by CodeBlock

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.Colors/index.html b/api/interfaces/headstartwp_core.react.Colors/index.html index 98857d16b..d2900d801 100644 --- a/api/interfaces/headstartwp_core.react.Colors/index.html +++ b/api/interfaces/headstartwp_core.react.Colors/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: Colors

@headstartwp/core.react.Colors

Hierarchy

Properties

backgroundColor

backgroundColor: string

Defined in

packages/core/src/react/blocks/types.ts:6


backgroundColorSlug

backgroundColorSlug: string

Defined in

packages/core/src/react/blocks/types.ts:5


gradient

gradient: string

Defined in

packages/core/src/react/blocks/types.ts:8


gradientSlug

gradientSlug: string

Defined in

packages/core/src/react/blocks/types.ts:7


linkColor

linkColor: string

Defined in

packages/core/src/react/blocks/types.ts:12


linkColorSlug

linkColorSlug: string

Defined in

packages/core/src/react/blocks/types.ts:11


textColor

textColor: string

Defined in

packages/core/src/react/blocks/types.ts:10


textColorSlug

textColorSlug: string

Defined in

packages/core/src/react/blocks/types.ts:9

- +
Skip to main content

Interface: Colors

@headstartwp/core.react.Colors

Hierarchy

Properties

backgroundColor

backgroundColor: string

Defined in

packages/core/src/react/blocks/types.ts:6


backgroundColorSlug

backgroundColorSlug: string

Defined in

packages/core/src/react/blocks/types.ts:5


gradient

gradient: string

Defined in

packages/core/src/react/blocks/types.ts:8


gradientSlug

gradientSlug: string

Defined in

packages/core/src/react/blocks/types.ts:7


linkColor

linkColor: string

Defined in

packages/core/src/react/blocks/types.ts:12


linkColorSlug

linkColorSlug: string

Defined in

packages/core/src/react/blocks/types.ts:11


textColor

textColor: string

Defined in

packages/core/src/react/blocks/types.ts:10


textColorSlug

textColorSlug: string

Defined in

packages/core/src/react/blocks/types.ts:9

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ColumnBlockProps/index.html b/api/interfaces/headstartwp_core.react.ColumnBlockProps/index.html index b871edba7..a117fa4c3 100644 --- a/api/interfaces/headstartwp_core.react.ColumnBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.ColumnBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: ColumnBlockProps

@headstartwp/core.react.ColumnBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

- +
Skip to main content

Interface: ColumnBlockProps

@headstartwp/core.react.ColumnBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ColumnsBlockProps/index.html b/api/interfaces/headstartwp_core.react.ColumnsBlockProps/index.html index cc8d56192..97816976b 100644 --- a/api/interfaces/headstartwp_core.react.ColumnsBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.ColumnsBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: ColumnsBlockProps

@headstartwp/core.react.ColumnsBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

- +
Skip to main content

Interface: ColumnsBlockProps

@headstartwp/core.react.ColumnsBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.CoverBlockProps/index.html b/api/interfaces/headstartwp_core.react.CoverBlockProps/index.html index 76ff9ef62..f433724df 100644 --- a/api/interfaces/headstartwp_core.react.CoverBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.CoverBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: CoverBlockProps

@headstartwp/core.react.CoverBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


dimRatio

dimRatio: number

Defined in

packages/core/src/react/blocks/CoverBlock.tsx:12


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


focalPoint

Optional focalPoint: Object

Type declaration

NameType
xstring | number
ystring | number

Defined in

packages/core/src/react/blocks/CoverBlock.tsx:16


hasParallax

hasParallax: boolean

Defined in

packages/core/src/react/blocks/CoverBlock.tsx:9


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


id

id: number

Defined in

packages/core/src/react/blocks/CoverBlock.tsx:11


isDark

isDark: boolean

Defined in

packages/core/src/react/blocks/CoverBlock.tsx:13


isRepeated

isRepeated: boolean

Defined in

packages/core/src/react/blocks/CoverBlock.tsx:10


minHeight

minHeight: number

Defined in

packages/core/src/react/blocks/CoverBlock.tsx:15


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


overlayColor

overlayColor: string

Defined in

packages/core/src/react/blocks/CoverBlock.tsx:8


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74


url

url: string

Defined in

packages/core/src/react/blocks/CoverBlock.tsx:14

- +
Skip to main content

Interface: CoverBlockProps

@headstartwp/core.react.CoverBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


dimRatio

dimRatio: number

Defined in

packages/core/src/react/blocks/CoverBlock.tsx:12


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


focalPoint

Optional focalPoint: Object

Type declaration

NameType
xstring | number
ystring | number

Defined in

packages/core/src/react/blocks/CoverBlock.tsx:16


hasParallax

hasParallax: boolean

Defined in

packages/core/src/react/blocks/CoverBlock.tsx:9


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


id

id: number

Defined in

packages/core/src/react/blocks/CoverBlock.tsx:11


isDark

isDark: boolean

Defined in

packages/core/src/react/blocks/CoverBlock.tsx:13


isRepeated

isRepeated: boolean

Defined in

packages/core/src/react/blocks/CoverBlock.tsx:10


minHeight

minHeight: number

Defined in

packages/core/src/react/blocks/CoverBlock.tsx:15


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


overlayColor

overlayColor: string

Defined in

packages/core/src/react/blocks/CoverBlock.tsx:8


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74


url

url: string

Defined in

packages/core/src/react/blocks/CoverBlock.tsx:14

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.FetchHookOptions/index.html b/api/interfaces/headstartwp_core.react.FetchHookOptions/index.html index b0352a77a..792c819d7 100644 --- a/api/interfaces/headstartwp_core.react.FetchHookOptions/index.html +++ b/api/interfaces/headstartwp_core.react.FetchHookOptions/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: FetchHookOptions<T>

@headstartwp/core.react.FetchHookOptions

Type parameters

Name
T

Properties

fetchStrategyOptions

Optional fetchStrategyOptions: Partial<FetchOptions>

Defined in

packages/core/src/react/hooks/types.ts:12


shouldFetch

Optional shouldFetch: boolean

Defined in

packages/core/src/react/hooks/types.ts:14


swr

Optional swr: Partial<PublicConfiguration<T, any, BareFetcher<any>>>

Defined in

packages/core/src/react/hooks/types.ts:13

- +
Skip to main content

Interface: FetchHookOptions<T>

@headstartwp/core.react.FetchHookOptions

Type parameters

Name
T

Properties

fetchStrategyOptions

Optional fetchStrategyOptions: Partial<FetchOptions>

Defined in

packages/core/src/react/hooks/types.ts:12


shouldFetch

Optional shouldFetch: boolean

Defined in

packages/core/src/react/hooks/types.ts:14


swr

Optional swr: Partial<PublicConfiguration<T, any, BareFetcher<any>>>

Defined in

packages/core/src/react/hooks/types.ts:13

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.FileBlockProps/index.html b/api/interfaces/headstartwp_core.react.FileBlockProps/index.html index 05634f4f8..87762bcdb 100644 --- a/api/interfaces/headstartwp_core.react.FileBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.FileBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: FileBlockProps

@headstartwp/core.react.FileBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


href

Optional href: string

Defined in

packages/core/src/react/blocks/FileBlock.tsx:8


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


id

Optional id: number

Defined in

packages/core/src/react/blocks/FileBlock.tsx:7


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


showDownloadButton

showDownloadButton: boolean

Defined in

packages/core/src/react/blocks/FileBlock.tsx:9


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

- +
Skip to main content

Interface: FileBlockProps

@headstartwp/core.react.FileBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


href

Optional href: string

Defined in

packages/core/src/react/blocks/FileBlock.tsx:8


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


id

Optional id: number

Defined in

packages/core/src/react/blocks/FileBlock.tsx:7


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


showDownloadButton

showDownloadButton: boolean

Defined in

packages/core/src/react/blocks/FileBlock.tsx:9


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.GroupBlockProps/index.html b/api/interfaces/headstartwp_core.react.GroupBlockProps/index.html index 15e62ae7e..7e7a09379 100644 --- a/api/interfaces/headstartwp_core.react.GroupBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.GroupBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: GroupBlockProps

@headstartwp/core.react.GroupBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


layout

Optional layout: Object

Type declaration

NameType
allowOrientation?boolean
justifyContent?"center" | "left" | "right" | "space-between"
type?string

Defined in

packages/core/src/react/blocks/GroupBlock.tsx:8


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74


tagName

Optional tagName: string

Defined in

packages/core/src/react/blocks/GroupBlock.tsx:7

- +
Skip to main content

Interface: GroupBlockProps

@headstartwp/core.react.GroupBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


layout

Optional layout: Object

Type declaration

NameType
allowOrientation?boolean
justifyContent?"center" | "left" | "right" | "space-between"
type?string

Defined in

packages/core/src/react/blocks/GroupBlock.tsx:8


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74


tagName

Optional tagName: string

Defined in

packages/core/src/react/blocks/GroupBlock.tsx:7

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.GutenbergBlockProps/index.html b/api/interfaces/headstartwp_core.react.GutenbergBlockProps/index.html index 885d09918..b1f7b08fd 100644 --- a/api/interfaces/headstartwp_core.react.GutenbergBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.GutenbergBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content
- +
Skip to main content
+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.HeadingBlockProps/index.html b/api/interfaces/headstartwp_core.react.HeadingBlockProps/index.html index 5c665e810..b2b6dfad7 100644 --- a/api/interfaces/headstartwp_core.react.HeadingBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.HeadingBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: HeadingBlockProps

@headstartwp/core.react.HeadingBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


level

level: number

Defined in

packages/core/src/react/blocks/HeadingBlock.tsx:7


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

- +
Skip to main content

Interface: HeadingBlockProps

@headstartwp/core.react.HeadingBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


level

level: number

Defined in

packages/core/src/react/blocks/HeadingBlock.tsx:7


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.HookResponse/index.html b/api/interfaces/headstartwp_core.react.HookResponse/index.html index 4678e6714..36066e5d8 100644 --- a/api/interfaces/headstartwp_core.react.HookResponse/index.html +++ b/api/interfaces/headstartwp_core.react.HookResponse/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: HookResponse

@headstartwp/core.react.HookResponse

Hierarchy

Properties

data

Optional data: Object

Defined in

packages/core/src/react/hooks/types.ts:5


error

Optional error: string

Defined in

packages/core/src/react/hooks/types.ts:6


isMainQuery

isMainQuery: boolean

Defined in

packages/core/src/react/hooks/types.ts:8


loading

loading: boolean

Defined in

packages/core/src/react/hooks/types.ts:7

- +
Skip to main content

Interface: HookResponse

@headstartwp/core.react.HookResponse

Hierarchy

Properties

data

Optional data: Object

Defined in

packages/core/src/react/hooks/types.ts:5


error

Optional error: string

Defined in

packages/core/src/react/hooks/types.ts:6


isMainQuery

isMainQuery: boolean

Defined in

packages/core/src/react/hooks/types.ts:8


loading

loading: boolean

Defined in

packages/core/src/react/hooks/types.ts:7

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.HtmlDecodeProps/index.html b/api/interfaces/headstartwp_core.react.HtmlDecodeProps/index.html index d28a462dc..eb6b01f59 100644 --- a/api/interfaces/headstartwp_core.react.HtmlDecodeProps/index.html +++ b/api/interfaces/headstartwp_core.react.HtmlDecodeProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content
- +
Skip to main content
+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IAudioBlock/index.html b/api/interfaces/headstartwp_core.react.IAudioBlock/index.html index a3692d36e..2cfbf2291 100644 --- a/api/interfaces/headstartwp_core.react.IAudioBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IAudioBlock/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: IAudioBlock

@headstartwp/core.react.IAudioBlock

The interface for the AudioBlock component.

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: AudioBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsAudioBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

- +
Skip to main content

Interface: IAudioBlock

@headstartwp/core.react.IAudioBlock

The interface for the AudioBlock component.

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: AudioBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsAudioBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IBlock/index.html b/api/interfaces/headstartwp_core.react.IBlock/index.html index e1cd574cd..f00f5ce72 100644 --- a/api/interfaces/headstartwp_core.react.IBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IBlock/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: IBlock<T>

@headstartwp/core.react.IBlock

The common interface for a block transform component

Type parameters

NameType
Textends IBlockAttributes

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

Omit.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

Omit.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: T) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsT
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Overrides

Omit.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

Omit.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

Omit.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

Omit.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

- +
Skip to main content

Interface: IBlock<T>

@headstartwp/core.react.IBlock

The common interface for a block transform component

Type parameters

NameType
Textends IBlockAttributes

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

Omit.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

Omit.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: T) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsT
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Overrides

Omit.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

Omit.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

Omit.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

Omit.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IBlockAttributes/index.html b/api/interfaces/headstartwp_core.react.IBlockAttributes/index.html index 9c0c9dffd..56e4edf59 100644 --- a/api/interfaces/headstartwp_core.react.IBlockAttributes/index.html +++ b/api/interfaces/headstartwp_core.react.IBlockAttributes/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: IBlockAttributes

@headstartwp/core.react.IBlockAttributes

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Defined in

packages/core/src/react/blocks/types.ts:74

- +
Skip to main content

Interface: IBlockAttributes

@headstartwp/core.react.IBlockAttributes

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Defined in

packages/core/src/react/blocks/types.ts:74

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IButtonBlock/index.html b/api/interfaces/headstartwp_core.react.IButtonBlock/index.html index 995120ceb..b52f19d16 100644 --- a/api/interfaces/headstartwp_core.react.IButtonBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IButtonBlock/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: IButtonBlock

@headstartwp/core.react.IButtonBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: ButtonBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsButtonBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

- +
Skip to main content

Interface: IButtonBlock

@headstartwp/core.react.IButtonBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: ButtonBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsButtonBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IButtonsBlock/index.html b/api/interfaces/headstartwp_core.react.IButtonsBlock/index.html index 28e33f593..a660725d8 100644 --- a/api/interfaces/headstartwp_core.react.IButtonsBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IButtonsBlock/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: IButtonsBlock

@headstartwp/core.react.IButtonsBlock

The interface for the ButtonsBlock component.

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: ButtonsBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsButtonsBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

- +
Skip to main content

Interface: IButtonsBlock

@headstartwp/core.react.IButtonsBlock

The interface for the ButtonsBlock component.

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: ButtonsBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsButtonsBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ICodeBlock/index.html b/api/interfaces/headstartwp_core.react.ICodeBlock/index.html index 86f25c726..2cbc1c878 100644 --- a/api/interfaces/headstartwp_core.react.ICodeBlock/index.html +++ b/api/interfaces/headstartwp_core.react.ICodeBlock/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: ICodeBlock

@headstartwp/core.react.ICodeBlock

The interface for the CodeBlock component.

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: CodeBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsCodeBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

- +
Skip to main content

Interface: ICodeBlock

@headstartwp/core.react.ICodeBlock

The interface for the CodeBlock component.

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: CodeBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsCodeBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IColumnBlock/index.html b/api/interfaces/headstartwp_core.react.IColumnBlock/index.html index a7d1e2fda..2e2d99553 100644 --- a/api/interfaces/headstartwp_core.react.IColumnBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IColumnBlock/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: IColumnBlock

@headstartwp/core.react.IColumnBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: ColumnBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsColumnBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

- +
Skip to main content

Interface: IColumnBlock

@headstartwp/core.react.IColumnBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: ColumnBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsColumnBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IColumnsBlock/index.html b/api/interfaces/headstartwp_core.react.IColumnsBlock/index.html index 0ad6300e5..8de501b69 100644 --- a/api/interfaces/headstartwp_core.react.IColumnsBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IColumnsBlock/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: IColumnsBlock

@headstartwp/core.react.IColumnsBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: ColumnsBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsColumnsBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

- +
Skip to main content

Interface: IColumnsBlock

@headstartwp/core.react.IColumnsBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: ColumnsBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsColumnsBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ICoverBlock/index.html b/api/interfaces/headstartwp_core.react.ICoverBlock/index.html index 1ac62a45c..1b2fb762e 100644 --- a/api/interfaces/headstartwp_core.react.ICoverBlock/index.html +++ b/api/interfaces/headstartwp_core.react.ICoverBlock/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: ICoverBlock

@headstartwp/core.react.ICoverBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: CoverBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsCoverBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

- +
Skip to main content

Interface: ICoverBlock

@headstartwp/core.react.ICoverBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: CoverBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsCoverBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IDataWPBlock/index.html b/api/interfaces/headstartwp_core.react.IDataWPBlock/index.html index 092a5272b..9d071f3a4 100644 --- a/api/interfaces/headstartwp_core.react.IDataWPBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IDataWPBlock/index.html @@ -7,13 +7,13 @@ - +
Skip to main content

Interface: IDataWPBlock

@headstartwp/core.react.IDataWPBlock

Indexable

[key: string]: unknown

- + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IFileBlock/index.html b/api/interfaces/headstartwp_core.react.IFileBlock/index.html index ddc1638d3..76d5d45cc 100644 --- a/api/interfaces/headstartwp_core.react.IFileBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IFileBlock/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: IFileBlock

@headstartwp/core.react.IFileBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: FileBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsFileBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

- +
Skip to main content

Interface: IFileBlock

@headstartwp/core.react.IFileBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: FileBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsFileBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IGroupBlock/index.html b/api/interfaces/headstartwp_core.react.IGroupBlock/index.html index 3e92f4632..2c9a7d1ac 100644 --- a/api/interfaces/headstartwp_core.react.IGroupBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IGroupBlock/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: IGroupBlock

@headstartwp/core.react.IGroupBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: GroupBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsGroupBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

- +
Skip to main content

Interface: IGroupBlock

@headstartwp/core.react.IGroupBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: GroupBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsGroupBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IHeadingBlock/index.html b/api/interfaces/headstartwp_core.react.IHeadingBlock/index.html index 4eb270064..adaeea570 100644 --- a/api/interfaces/headstartwp_core.react.IHeadingBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IHeadingBlock/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: IHeadingBlock

@headstartwp/core.react.IHeadingBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: HeadingBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsHeadingBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

- +
Skip to main content

Interface: IHeadingBlock

@headstartwp/core.react.IHeadingBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: HeadingBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsHeadingBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IImageBlock/index.html b/api/interfaces/headstartwp_core.react.IImageBlock/index.html index b0b0b6821..371b8a6b5 100644 --- a/api/interfaces/headstartwp_core.react.IImageBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IImageBlock/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: IImageBlock

@headstartwp/core.react.IImageBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: ImageBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsImageBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

- +
Skip to main content

Interface: IImageBlock

@headstartwp/core.react.IImageBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: ImageBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsImageBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IListBlock/index.html b/api/interfaces/headstartwp_core.react.IListBlock/index.html index ec23473dc..553ed7d6d 100644 --- a/api/interfaces/headstartwp_core.react.IListBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IListBlock/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: IListBlock

@headstartwp/core.react.IListBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: ListBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsListBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

- +
Skip to main content

Interface: IListBlock

@headstartwp/core.react.IListBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: ListBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsListBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IMediaTextBlock/index.html b/api/interfaces/headstartwp_core.react.IMediaTextBlock/index.html index 78e7b42fa..00998b735 100644 --- a/api/interfaces/headstartwp_core.react.IMediaTextBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IMediaTextBlock/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: IMediaTextBlock

@headstartwp/core.react.IMediaTextBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: MediaTextBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsMediaTextBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

- +
Skip to main content

Interface: IMediaTextBlock

@headstartwp/core.react.IMediaTextBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: MediaTextBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsMediaTextBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IParagraphBlock/index.html b/api/interfaces/headstartwp_core.react.IParagraphBlock/index.html index ab1fc8695..2b775394e 100644 --- a/api/interfaces/headstartwp_core.react.IParagraphBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IParagraphBlock/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: IParagraphBlock

@headstartwp/core.react.IParagraphBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: ParagraphBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsParagraphBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

- +
Skip to main content

Interface: IParagraphBlock

@headstartwp/core.react.IParagraphBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: ParagraphBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsParagraphBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IPreformattedBlock/index.html b/api/interfaces/headstartwp_core.react.IPreformattedBlock/index.html index 6fab004dc..0921a8469 100644 --- a/api/interfaces/headstartwp_core.react.IPreformattedBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IPreformattedBlock/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: IPreformattedBlock

@headstartwp/core.react.IPreformattedBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: PreformattedBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsPreformattedBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

- +
Skip to main content

Interface: IPreformattedBlock

@headstartwp/core.react.IPreformattedBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: PreformattedBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsPreformattedBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IPullQuoteBlock/index.html b/api/interfaces/headstartwp_core.react.IPullQuoteBlock/index.html index 70d313273..8e27e036f 100644 --- a/api/interfaces/headstartwp_core.react.IPullQuoteBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IPullQuoteBlock/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: IPullQuoteBlock

@headstartwp/core.react.IPullQuoteBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: PullQuoteBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsPullQuoteBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

- +
Skip to main content

Interface: IPullQuoteBlock

@headstartwp/core.react.IPullQuoteBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: PullQuoteBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsPullQuoteBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IQuoteBlock/index.html b/api/interfaces/headstartwp_core.react.IQuoteBlock/index.html index 0f9ce58ce..646bf0cde 100644 --- a/api/interfaces/headstartwp_core.react.IQuoteBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IQuoteBlock/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: IQuoteBlock

@headstartwp/core.react.IQuoteBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: QuoteBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsQuoteBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

- +
Skip to main content

Interface: IQuoteBlock

@headstartwp/core.react.IQuoteBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: QuoteBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsQuoteBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ISeparatorBlock/index.html b/api/interfaces/headstartwp_core.react.ISeparatorBlock/index.html index 99c0c1beb..37dbb5305 100644 --- a/api/interfaces/headstartwp_core.react.ISeparatorBlock/index.html +++ b/api/interfaces/headstartwp_core.react.ISeparatorBlock/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: ISeparatorBlock

@headstartwp/core.react.ISeparatorBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: SeparatorBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsSeparatorBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

- +
Skip to main content

Interface: ISeparatorBlock

@headstartwp/core.react.ISeparatorBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: SeparatorBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsSeparatorBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ISpacerBlock/index.html b/api/interfaces/headstartwp_core.react.ISpacerBlock/index.html index d85914908..8226138ff 100644 --- a/api/interfaces/headstartwp_core.react.ISpacerBlock/index.html +++ b/api/interfaces/headstartwp_core.react.ISpacerBlock/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: ISpacerBlock

@headstartwp/core.react.ISpacerBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: SpacerBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsSpacerBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

- +
Skip to main content

Interface: ISpacerBlock

@headstartwp/core.react.ISpacerBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: SpacerBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsSpacerBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ITableBlock/index.html b/api/interfaces/headstartwp_core.react.ITableBlock/index.html index fc84aca0d..1c6943c28 100644 --- a/api/interfaces/headstartwp_core.react.ITableBlock/index.html +++ b/api/interfaces/headstartwp_core.react.ITableBlock/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: ITableBlock

@headstartwp/core.react.ITableBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: TableBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsTableBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

- +
Skip to main content

Interface: ITableBlock

@headstartwp/core.react.ITableBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: TableBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsTableBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IVerseBlock/index.html b/api/interfaces/headstartwp_core.react.IVerseBlock/index.html index b4fa72d72..ee5b1a04a 100644 --- a/api/interfaces/headstartwp_core.react.IVerseBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IVerseBlock/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: IVerseBlock

@headstartwp/core.react.IVerseBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: VerseBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsVerseBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

- +
Skip to main content

Interface: IVerseBlock

@headstartwp/core.react.IVerseBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: VerseBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsVerseBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock/index.html b/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock/index.html index 5270f71ef..09ee2f241 100644 --- a/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock/index.html @@ -7,14 +7,14 @@ - +
-
Skip to main content

Interface: IYoutubeLiteBlock

@headstartwp/core.react.IYoutubeLiteBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: YoutubeLiteBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsYoutubeLiteBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

- +
Skip to main content

Interface: IYoutubeLiteBlock

@headstartwp/core.react.IYoutubeLiteBlock

The common interface for a block transform component

Hierarchy

Properties

children

Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from

IBlock.children

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:53


classList

Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from

IBlock.classList

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:41


className

Optional className: string

Inherited from

IBlock.className

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:66


component

component: (props: YoutubeLiteBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters
NameType
propsYoutubeLiteBlockProps
Returns

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from

IBlock.component

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:67


domNode

Optional domNode: Element

Inherited from

IBlock.domNode

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:65


exclude

Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters
NameType
childNodeElement
site?HeadlessConfig
Returns

boolean

Inherited from

IBlock.exclude

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:27


style

Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from

IBlock.style

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:58


tagName

Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from

IBlock.tagName

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:34

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ImageBlockProps/index.html b/api/interfaces/headstartwp_core.react.ImageBlockProps/index.html index dbfa0b55b..e40029133 100644 --- a/api/interfaces/headstartwp_core.react.ImageBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.ImageBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: ImageBlockProps

@headstartwp/core.react.ImageBlockProps

Hierarchy

Properties

alt

Optional alt: string

Defined in

packages/core/src/react/blocks/ImageBlock.tsx:14


attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


height

Optional height: number

Defined in

packages/core/src/react/blocks/ImageBlock.tsx:10


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


linkDestination

Optional linkDestination: string

Defined in

packages/core/src/react/blocks/ImageBlock.tsx:12


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


sizeSlug

Optional sizeSlug: string

Defined in

packages/core/src/react/blocks/ImageBlock.tsx:11


src

src: string

Defined in

packages/core/src/react/blocks/ImageBlock.tsx:13


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74


width

Optional width: number

Defined in

packages/core/src/react/blocks/ImageBlock.tsx:9

- +
Skip to main content

Interface: ImageBlockProps

@headstartwp/core.react.ImageBlockProps

Hierarchy

Properties

alt

Optional alt: string

Defined in

packages/core/src/react/blocks/ImageBlock.tsx:14


attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


height

Optional height: number

Defined in

packages/core/src/react/blocks/ImageBlock.tsx:10


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


linkDestination

Optional linkDestination: string

Defined in

packages/core/src/react/blocks/ImageBlock.tsx:12


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


sizeSlug

Optional sizeSlug: string

Defined in

packages/core/src/react/blocks/ImageBlock.tsx:11


src

src: string

Defined in

packages/core/src/react/blocks/ImageBlock.tsx:13


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74


width

Optional width: number

Defined in

packages/core/src/react/blocks/ImageBlock.tsx:9

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ListBlockProps/index.html b/api/interfaces/headstartwp_core.react.ListBlockProps/index.html index 9124d49fa..e80423125 100644 --- a/api/interfaces/headstartwp_core.react.ListBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.ListBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: ListBlockProps

@headstartwp/core.react.ListBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


ordered

ordered: boolean

Defined in

packages/core/src/react/blocks/ListBlock.tsx:7


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

- +
Skip to main content

Interface: ListBlockProps

@headstartwp/core.react.ListBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


ordered

ordered: boolean

Defined in

packages/core/src/react/blocks/ListBlock.tsx:7


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.MediaTextBlockProps/index.html b/api/interfaces/headstartwp_core.react.MediaTextBlockProps/index.html index 2f4a7c4bc..04c518896 100644 --- a/api/interfaces/headstartwp_core.react.MediaTextBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.MediaTextBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: MediaTextBlockProps

@headstartwp/core.react.MediaTextBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


focalPoint

Optional focalPoint: Object

Type declaration

NameType
xstring | number
ystring | number

Defined in

packages/core/src/react/blocks/MediaTextBlock.tsx:13


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


imageFill

imageFill: boolean

Defined in

packages/core/src/react/blocks/MediaTextBlock.tsx:12


mediaId

Optional mediaId: number

Defined in

packages/core/src/react/blocks/MediaTextBlock.tsx:8


mediaPosition

Optional mediaPosition: "left" | "right"

Defined in

packages/core/src/react/blocks/MediaTextBlock.tsx:7


mediaSizeSlug

Optional mediaSizeSlug: string

Defined in

packages/core/src/react/blocks/MediaTextBlock.tsx:10


mediaType

Optional mediaType: "image" | "video"

Defined in

packages/core/src/react/blocks/MediaTextBlock.tsx:9


mediaWidth

Optional mediaWidth: number

Defined in

packages/core/src/react/blocks/MediaTextBlock.tsx:11


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74


verticalAlignment

Optional verticalAlignment: "center" | "top" | "bottom"

Defined in

packages/core/src/react/blocks/MediaTextBlock.tsx:17

- +
Skip to main content

Interface: MediaTextBlockProps

@headstartwp/core.react.MediaTextBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


focalPoint

Optional focalPoint: Object

Type declaration

NameType
xstring | number
ystring | number

Defined in

packages/core/src/react/blocks/MediaTextBlock.tsx:13


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


imageFill

imageFill: boolean

Defined in

packages/core/src/react/blocks/MediaTextBlock.tsx:12


mediaId

Optional mediaId: number

Defined in

packages/core/src/react/blocks/MediaTextBlock.tsx:8


mediaPosition

Optional mediaPosition: "left" | "right"

Defined in

packages/core/src/react/blocks/MediaTextBlock.tsx:7


mediaSizeSlug

Optional mediaSizeSlug: string

Defined in

packages/core/src/react/blocks/MediaTextBlock.tsx:10


mediaType

Optional mediaType: "image" | "video"

Defined in

packages/core/src/react/blocks/MediaTextBlock.tsx:9


mediaWidth

Optional mediaWidth: number

Defined in

packages/core/src/react/blocks/MediaTextBlock.tsx:11


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74


verticalAlignment

Optional verticalAlignment: "center" | "top" | "bottom"

Defined in

packages/core/src/react/blocks/MediaTextBlock.tsx:17

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ParagraphBlockProps/index.html b/api/interfaces/headstartwp_core.react.ParagraphBlockProps/index.html index c24c991ff..b5d54ebf5 100644 --- a/api/interfaces/headstartwp_core.react.ParagraphBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.ParagraphBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: ParagraphBlockProps

@headstartwp/core.react.ParagraphBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


dropCap

Optional dropCap: boolean

Defined in

packages/core/src/react/blocks/ParagraphBlock.tsx:8


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

- +
Skip to main content

Interface: ParagraphBlockProps

@headstartwp/core.react.ParagraphBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


dropCap

Optional dropCap: boolean

Defined in

packages/core/src/react/blocks/ParagraphBlock.tsx:8


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.PreformattedBlockProps/index.html b/api/interfaces/headstartwp_core.react.PreformattedBlockProps/index.html index a282f3900..39a81a824 100644 --- a/api/interfaces/headstartwp_core.react.PreformattedBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.PreformattedBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: PreformattedBlockProps

@headstartwp/core.react.PreformattedBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

- +
Skip to main content

Interface: PreformattedBlockProps

@headstartwp/core.react.PreformattedBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.PullQuoteBlockProps/index.html b/api/interfaces/headstartwp_core.react.PullQuoteBlockProps/index.html index d4b2c2e6a..ff0c2b9b2 100644 --- a/api/interfaces/headstartwp_core.react.PullQuoteBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.PullQuoteBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: PullQuoteBlockProps

@headstartwp/core.react.PullQuoteBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


borderColor

Optional borderColor: string

Defined in

packages/core/src/react/blocks/PullQuote.tsx:10


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


cite

cite: string

Defined in

packages/core/src/react/blocks/PullQuote.tsx:9


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


quote

quote: string

Defined in

packages/core/src/react/blocks/PullQuote.tsx:8


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

- +
Skip to main content

Interface: PullQuoteBlockProps

@headstartwp/core.react.PullQuoteBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


borderColor

Optional borderColor: string

Defined in

packages/core/src/react/blocks/PullQuote.tsx:10


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


cite

cite: string

Defined in

packages/core/src/react/blocks/PullQuote.tsx:9


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


quote

quote: string

Defined in

packages/core/src/react/blocks/PullQuote.tsx:8


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.QuoteBlockProps/index.html b/api/interfaces/headstartwp_core.react.QuoteBlockProps/index.html index 34c62824f..ce2235f17 100644 --- a/api/interfaces/headstartwp_core.react.QuoteBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.QuoteBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: QuoteBlockProps

@headstartwp/core.react.QuoteBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

- +
Skip to main content

Interface: QuoteBlockProps

@headstartwp/core.react.QuoteBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.SafeHtmlProps/index.html b/api/interfaces/headstartwp_core.react.SafeHtmlProps/index.html index 0679a6924..1e0ab4f37 100644 --- a/api/interfaces/headstartwp_core.react.SafeHtmlProps/index.html +++ b/api/interfaces/headstartwp_core.react.SafeHtmlProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: SafeHtmlProps

@headstartwp/core.react.SafeHtmlProps

Properties

html

html: string

The HTML string to be rendered.

<SafeHtml html="<div><p>hello world</p> div content</div>" />

Defined in

packages/core/src/react/components/SafeHtml.tsx:14


ksesAllowList

Optional ksesAllowList: IWhiteList

The allow list for the parser

<SafeHtml
html="<div><p>hello world</p> div content</div>"
ksesAllowList={{ div: [] }}
/>

Defined in

packages/core/src/react/components/SafeHtml.tsx:26

- +
Skip to main content

Interface: SafeHtmlProps

@headstartwp/core.react.SafeHtmlProps

Properties

html

html: string

The HTML string to be rendered.

<SafeHtml html="<div><p>hello world</p> div content</div>" />

Defined in

packages/core/src/react/components/SafeHtml.tsx:14


ksesAllowList

Optional ksesAllowList: IWhiteList

The allow list for the parser

<SafeHtml
html="<div><p>hello world</p> div content</div>"
ksesAllowList={{ div: [] }}
/>

Defined in

packages/core/src/react/components/SafeHtml.tsx:26

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.SeparatorBlockProps/index.html b/api/interfaces/headstartwp_core.react.SeparatorBlockProps/index.html index fd1a24603..a8e048e63 100644 --- a/api/interfaces/headstartwp_core.react.SeparatorBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.SeparatorBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: SeparatorBlockProps

@headstartwp/core.react.SeparatorBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

- +
Skip to main content

Interface: SeparatorBlockProps

@headstartwp/core.react.SeparatorBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties/index.html b/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties/index.html index 150046e7f..e4d2211be 100644 --- a/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties/index.html +++ b/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties/index.html @@ -7,13 +7,13 @@ - +
Skip to main content
- + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.SettingsProperties/index.html b/api/interfaces/headstartwp_core.react.SettingsProperties/index.html index d2bc77c45..81bd456d9 100644 --- a/api/interfaces/headstartwp_core.react.SettingsProperties/index.html +++ b/api/interfaces/headstartwp_core.react.SettingsProperties/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: SettingsProperties

@headstartwp/core.react.SettingsProperties

Indexable

[k: string]: unknown

Properties

appearanceTools

Optional appearanceTools: boolean

Setting that enables ui tools.

Defined in

packages/core/src/react/provider/types.ts:358


border

Optional border: Object

Settings related to borders.

Type declaration

NameTypeDescription
color?booleanAllow users to set custom border colors.
radius?booleanAllow users to set custom border radius.
style?booleanAllow users to set custom border styles.
width?booleanAllow users to set custom border widths.

Defined in

packages/core/src/react/provider/types.ts:362


color

Optional color: Object

Settings related to colors.

Type declaration

NameTypeDescription
background?booleanAllow users to set background colors.
custom?booleanAllow users to select custom colors.
customDuotone?booleanAllow users to create custom duotone filters.
customGradient?booleanAllow users to create custom gradients.
defaultGradients?booleanAllow users to choose colors from the default gradients.
defaultPalette?booleanAllow users to choose colors from the default palette.
duotone?SettingsDuotoneDuotone presets for the duotone picker. Doesn't generate classes or properties.
gradients?SettingsGradientGradient presets for the gradient picker. Generates a single class (.has-{slug}-background) and custom property (--wp--preset--gradient--{slug}) per preset value.
link?booleanAllow users to set link colors.
palette?SettingsColorPaletteColor palette presets for the color picker. Generates three classes (.has-{slug}-color, .has-{slug}-background-color, and .has-{slug}-border-color) and a single custom property (--wp--preset--color--{slug}) per preset value.
text?booleanAllow users to set text colors.

Defined in

packages/core/src/react/provider/types.ts:383


custom

Optional custom: Object

Generate custom CSS custom properties of the form --wp--custom--{key}--{nested-key}: {value};. camelCased keys are transformed to kebab-case as to follow the CSS property naming schema. Keys at different depth levels are separated by --, so keys should not include -- in the name.

Index signature

[k: string]: string | number | SettingsCustomAdditionalProperties

Defined in

packages/core/src/react/provider/types.ts:543


layout

Optional layout: Object

Settings related to layout.

Type declaration

NameTypeDescription
contentSize?stringSets the max-width of the content.
wideSize?stringSets the max-width of wide (.alignwide) content.

Defined in

packages/core/src/react/provider/types.ts:435


spacing

Optional spacing: Object

Settings related to spacing.

Type declaration

NameTypeDescription
blockGap?null | booleanEnables --wp--style--block-gap to be generated from styles.spacing.blockGap. A value of null instead of false further disables layout styles from being generated.
margin?booleanAllow users to set a custom margin.
padding?booleanAllow users to set a custom padding.
units?string[]List of units the user can use for spacing values.

Defined in

packages/core/src/react/provider/types.ts:448


typography

Optional typography: Object

Settings related to typography.

Type declaration

NameTypeDescription
customFontSize?booleanAllow users to set custom font sizes.
dropCap?booleanEnable drop cap.
fontFamilies?{ fontFamily?: string ; name?: string ; slug?: string }[]Font family presets for the font family selector. Generates a single custom property (--wp--preset--font-family--{slug}) per preset value.
fontSizes?{ name?: string ; size?: string ; slug?: string }[]Font size presets for the font size selector. Generates a single class (.has-{slug}-color) and custom property (--wp--preset--font-size--{slug}) per preset value.
fontStyle?booleanAllow users to set custom font styles.
fontWeight?booleanAllow users to set custom font weights.
letterSpacing?booleanAllow users to set custom letter spacing.
lineHeight?booleanAllow users to set custom line height.
textDecoration?booleanAllow users to set custom text decorations.
textTransform?booleanAllow users to set custom text transforms.

Defined in

packages/core/src/react/provider/types.ts:470

- +
Skip to main content

Interface: SettingsProperties

@headstartwp/core.react.SettingsProperties

Indexable

[k: string]: unknown

Properties

appearanceTools

Optional appearanceTools: boolean

Setting that enables ui tools.

Defined in

packages/core/src/react/provider/types.ts:358


border

Optional border: Object

Settings related to borders.

Type declaration

NameTypeDescription
color?booleanAllow users to set custom border colors.
radius?booleanAllow users to set custom border radius.
style?booleanAllow users to set custom border styles.
width?booleanAllow users to set custom border widths.

Defined in

packages/core/src/react/provider/types.ts:362


color

Optional color: Object

Settings related to colors.

Type declaration

NameTypeDescription
background?booleanAllow users to set background colors.
custom?booleanAllow users to select custom colors.
customDuotone?booleanAllow users to create custom duotone filters.
customGradient?booleanAllow users to create custom gradients.
defaultGradients?booleanAllow users to choose colors from the default gradients.
defaultPalette?booleanAllow users to choose colors from the default palette.
duotone?SettingsDuotoneDuotone presets for the duotone picker. Doesn't generate classes or properties.
gradients?SettingsGradientGradient presets for the gradient picker. Generates a single class (.has-{slug}-background) and custom property (--wp--preset--gradient--{slug}) per preset value.
link?booleanAllow users to set link colors.
palette?SettingsColorPaletteColor palette presets for the color picker. Generates three classes (.has-{slug}-color, .has-{slug}-background-color, and .has-{slug}-border-color) and a single custom property (--wp--preset--color--{slug}) per preset value.
text?booleanAllow users to set text colors.

Defined in

packages/core/src/react/provider/types.ts:383


custom

Optional custom: Object

Generate custom CSS custom properties of the form --wp--custom--{key}--{nested-key}: {value};. camelCased keys are transformed to kebab-case as to follow the CSS property naming schema. Keys at different depth levels are separated by --, so keys should not include -- in the name.

Index signature

[k: string]: string | number | SettingsCustomAdditionalProperties

Defined in

packages/core/src/react/provider/types.ts:543


layout

Optional layout: Object

Settings related to layout.

Type declaration

NameTypeDescription
contentSize?stringSets the max-width of the content.
wideSize?stringSets the max-width of wide (.alignwide) content.

Defined in

packages/core/src/react/provider/types.ts:435


spacing

Optional spacing: Object

Settings related to spacing.

Type declaration

NameTypeDescription
blockGap?null | booleanEnables --wp--style--block-gap to be generated from styles.spacing.blockGap. A value of null instead of false further disables layout styles from being generated.
margin?booleanAllow users to set a custom margin.
padding?booleanAllow users to set a custom padding.
units?string[]List of units the user can use for spacing values.

Defined in

packages/core/src/react/provider/types.ts:448


typography

Optional typography: Object

Settings related to typography.

Type declaration

NameTypeDescription
customFontSize?booleanAllow users to set custom font sizes.
dropCap?booleanEnable drop cap.
fontFamilies?{ fontFamily?: string ; name?: string ; slug?: string }[]Font family presets for the font family selector. Generates a single custom property (--wp--preset--font-family--{slug}) per preset value.
fontSizes?{ name?: string ; size?: string ; slug?: string }[]Font size presets for the font size selector. Generates a single class (.has-{slug}-color) and custom property (--wp--preset--font-size--{slug}) per preset value.
fontStyle?booleanAllow users to set custom font styles.
fontWeight?booleanAllow users to set custom font weights.
letterSpacing?booleanAllow users to set custom letter spacing.
lineHeight?booleanAllow users to set custom line height.
textDecoration?booleanAllow users to set custom text decorations.
textTransform?booleanAllow users to set custom text transforms.

Defined in

packages/core/src/react/provider/types.ts:470

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.SpacerBlockProps/index.html b/api/interfaces/headstartwp_core.react.SpacerBlockProps/index.html index 9423f5612..df43846f1 100644 --- a/api/interfaces/headstartwp_core.react.SpacerBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.SpacerBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: SpacerBlockProps

@headstartwp/core.react.SpacerBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


height

Optional height: string

Defined in

packages/core/src/react/blocks/SpacerBlock.tsx:7


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

- +
Skip to main content

Interface: SpacerBlockProps

@headstartwp/core.react.SpacerBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


height

Optional height: string

Defined in

packages/core/src/react/blocks/SpacerBlock.tsx:7


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete/index.html b/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete/index.html index 6873cc005..2c30a3c0e 100644 --- a/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete/index.html +++ b/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content
- +
Skip to main content
+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.StylesProperties/index.html b/api/interfaces/headstartwp_core.react.StylesProperties/index.html index e42c4b290..4cf9d5a96 100644 --- a/api/interfaces/headstartwp_core.react.StylesProperties/index.html +++ b/api/interfaces/headstartwp_core.react.StylesProperties/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: StylesProperties

@headstartwp/core.react.StylesProperties

Indexable

[k: string]: unknown

Properties

border

Optional border: Object

Border styles.

Type declaration

NameTypeDescription
color?stringSets the border-color CSS property.
radius?stringSets the border-radius CSS property.
style?stringSets the border-style CSS property.
width?stringSets the border-width CSS property.

Defined in

packages/core/src/react/provider/types.ts:555


color

Optional color: Object

Color styles.

Type declaration

NameTypeDescription
background?stringSets the background-color CSS property.
gradient?stringSets the background CSS property.
text?stringSets the color CSS property.

Defined in

packages/core/src/react/provider/types.ts:576


spacing

Optional spacing: Object

Spacing styles.

Type declaration

NameTypeDescription
blockGap?stringSets the --wp--style--block-gap CSS custom property when settings.spacing.blockGap is true.
margin?{ bottom?: string ; left?: string ; right?: string ; top?: string }Margin styles.
margin.bottom?stringSets the margin-bottom CSS property.
margin.left?stringSets the margin-left CSS property.
margin.right?stringSets the margin-right CSS property.
margin.top?stringSets the margin-top CSS property.
padding?{ bottom?: string ; left?: string ; right?: string ; top?: string }Padding styles.
padding.bottom?stringSets the padding-bottom CSS property.
padding.left?stringSets the padding-left CSS property.
padding.right?stringSets the padding-right CSS property.
padding.top?stringSets the padding-top CSS property.

Defined in

packages/core/src/react/provider/types.ts:593


typography

Optional typography: Object

Typography styles.

Type declaration

NameTypeDescription
fontFamily?stringSets the font-family CSS property.
fontSize?stringSets the font-size CSS property.
fontStyle?stringSets the font-style CSS property.
fontWeight?stringSets the font-weight CSS property.
letterSpacing?stringSets the letter-spacing CSS property.
lineHeight?stringSets the line-height CSS property.
textDecoration?stringSets the text-decoration CSS property.
textTransform?stringSets the text-transform CSS property.

Defined in

packages/core/src/react/provider/types.ts:644

- +
Skip to main content

Interface: StylesProperties

@headstartwp/core.react.StylesProperties

Indexable

[k: string]: unknown

Properties

border

Optional border: Object

Border styles.

Type declaration

NameTypeDescription
color?stringSets the border-color CSS property.
radius?stringSets the border-radius CSS property.
style?stringSets the border-style CSS property.
width?stringSets the border-width CSS property.

Defined in

packages/core/src/react/provider/types.ts:555


color

Optional color: Object

Color styles.

Type declaration

NameTypeDescription
background?stringSets the background-color CSS property.
gradient?stringSets the background CSS property.
text?stringSets the color CSS property.

Defined in

packages/core/src/react/provider/types.ts:576


spacing

Optional spacing: Object

Spacing styles.

Type declaration

NameTypeDescription
blockGap?stringSets the --wp--style--block-gap CSS custom property when settings.spacing.blockGap is true.
margin?{ bottom?: string ; left?: string ; right?: string ; top?: string }Margin styles.
margin.bottom?stringSets the margin-bottom CSS property.
margin.left?stringSets the margin-left CSS property.
margin.right?stringSets the margin-right CSS property.
margin.top?stringSets the margin-top CSS property.
padding?{ bottom?: string ; left?: string ; right?: string ; top?: string }Padding styles.
padding.bottom?stringSets the padding-bottom CSS property.
padding.left?stringSets the padding-left CSS property.
padding.right?stringSets the padding-right CSS property.
padding.top?stringSets the padding-top CSS property.

Defined in

packages/core/src/react/provider/types.ts:593


typography

Optional typography: Object

Typography styles.

Type declaration

NameTypeDescription
fontFamily?stringSets the font-family CSS property.
fontSize?stringSets the font-size CSS property.
fontStyle?stringSets the font-style CSS property.
fontWeight?stringSets the font-weight CSS property.
letterSpacing?stringSets the letter-spacing CSS property.
lineHeight?stringSets the line-height CSS property.
textDecoration?stringSets the text-decoration CSS property.
textTransform?stringSets the text-transform CSS property.

Defined in

packages/core/src/react/provider/types.ts:644

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.TableBlockProps/index.html b/api/interfaces/headstartwp_core.react.TableBlockProps/index.html index 5f3695584..5b636f946 100644 --- a/api/interfaces/headstartwp_core.react.TableBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.TableBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: TableBlockProps

@headstartwp/core.react.TableBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


hasFixedLayout

Optional hasFixedLayout: boolean

Defined in

packages/core/src/react/blocks/TableBlock.tsx:7


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

- +
Skip to main content

Interface: TableBlockProps

@headstartwp/core.react.TableBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


hasFixedLayout

Optional hasFixedLayout: boolean

Defined in

packages/core/src/react/blocks/TableBlock.tsx:7


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.Typography/index.html b/api/interfaces/headstartwp_core.react.Typography/index.html index 86311ac65..b55c4ecc6 100644 --- a/api/interfaces/headstartwp_core.react.Typography/index.html +++ b/api/interfaces/headstartwp_core.react.Typography/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: Typography

@headstartwp/core.react.Typography

Properties

fontSize

fontSize: Object

Type declaration

NameType
slugstring
valuestring

Defined in

packages/core/src/react/blocks/types.ts:24


letterSpacing

Optional letterSpacing: string

Defined in

packages/core/src/react/blocks/types.ts:37


lineHeight

Optional lineHeight: string

Defined in

packages/core/src/react/blocks/types.ts:35


supportsCustomFontSize

supportsCustomFontSize: boolean

Defined in

packages/core/src/react/blocks/types.ts:29


supportsFontStyle

supportsFontStyle: boolean

Defined in

packages/core/src/react/blocks/types.ts:28


supportsFontWeight

supportsFontWeight: boolean

Defined in

packages/core/src/react/blocks/types.ts:30


supportsLetterSpacing

supportsLetterSpacing: boolean

Defined in

packages/core/src/react/blocks/types.ts:31


supportsLineHeight

supportsLineHeight: boolean

Defined in

packages/core/src/react/blocks/types.ts:32


supportsTextDecoration

supportsTextDecoration: boolean

Defined in

packages/core/src/react/blocks/types.ts:33


supportsTextTransform

supportsTextTransform: boolean

Defined in

packages/core/src/react/blocks/types.ts:34


textTransform

Optional textTransform: string

Defined in

packages/core/src/react/blocks/types.ts:36

- +
Skip to main content

Interface: Typography

@headstartwp/core.react.Typography

Properties

fontSize

fontSize: Object

Type declaration

NameType
slugstring
valuestring

Defined in

packages/core/src/react/blocks/types.ts:24


letterSpacing

Optional letterSpacing: string

Defined in

packages/core/src/react/blocks/types.ts:37


lineHeight

Optional lineHeight: string

Defined in

packages/core/src/react/blocks/types.ts:35


supportsCustomFontSize

supportsCustomFontSize: boolean

Defined in

packages/core/src/react/blocks/types.ts:29


supportsFontStyle

supportsFontStyle: boolean

Defined in

packages/core/src/react/blocks/types.ts:28


supportsFontWeight

supportsFontWeight: boolean

Defined in

packages/core/src/react/blocks/types.ts:30


supportsLetterSpacing

supportsLetterSpacing: boolean

Defined in

packages/core/src/react/blocks/types.ts:31


supportsLineHeight

supportsLineHeight: boolean

Defined in

packages/core/src/react/blocks/types.ts:32


supportsTextDecoration

supportsTextDecoration: boolean

Defined in

packages/core/src/react/blocks/types.ts:33


supportsTextTransform

supportsTextTransform: boolean

Defined in

packages/core/src/react/blocks/types.ts:34


textTransform

Optional textTransform: string

Defined in

packages/core/src/react/blocks/types.ts:36

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.VerseBlockProps/index.html b/api/interfaces/headstartwp_core.react.VerseBlockProps/index.html index fca74580c..7c8048bbf 100644 --- a/api/interfaces/headstartwp_core.react.VerseBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.VerseBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: VerseBlockProps

@headstartwp/core.react.VerseBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

- +
Skip to main content

Interface: VerseBlockProps

@headstartwp/core.react.VerseBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.WpThemeJSON/index.html b/api/interfaces/headstartwp_core.react.WpThemeJSON/index.html index 13d0a6335..f7db80775 100644 --- a/api/interfaces/headstartwp_core.react.WpThemeJSON/index.html +++ b/api/interfaces/headstartwp_core.react.WpThemeJSON/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: WpThemeJSON

@headstartwp/core.react.WpThemeJSON

Properties

$schema

Optional $schema: string

JSON schema URI for theme.json.

Defined in

packages/core/src/react/provider/types.ts:99


customTemplates

Optional customTemplates: { name: string ; postTypes?: string[] ; title: string }[]

Additional metadata for custom templates defined in the templates folder.

Defined in

packages/core/src/react/provider/types.ts:319


settings

Optional settings: SettingsProperties & { blocks?: { core/archives?: SettingsPropertiesComplete ; core/audio?: SettingsPropertiesComplete ; core/block?: SettingsPropertiesComplete ; core/button?: SettingsPropertiesComplete ; core/buttons?: SettingsPropertiesComplete ; core/calendar?: SettingsPropertiesComplete ; core/categories?: SettingsPropertiesComplete ; core/code?: SettingsPropertiesComplete ; core/column?: SettingsPropertiesComplete ; core/columns?: SettingsPropertiesComplete ; core/comment-author-avatar?: SettingsPropertiesComplete ; core/comment-author-name?: SettingsPropertiesComplete ; core/comment-content?: SettingsPropertiesComplete ; core/comment-date?: SettingsPropertiesComplete ; core/comment-edit-link?: SettingsPropertiesComplete ; core/comment-reply-link?: SettingsPropertiesComplete ; core/comment-template?: SettingsPropertiesComplete ; core/comments-query-loop?: SettingsPropertiesComplete ; core/cover?: SettingsPropertiesComplete ; core/embed?: SettingsPropertiesComplete ; core/file?: SettingsPropertiesComplete ; core/freeform?: SettingsPropertiesComplete ; core/gallery?: SettingsPropertiesComplete ; core/group?: SettingsPropertiesComplete ; core/heading?: SettingsPropertiesComplete ; core/home-link?: SettingsPropertiesComplete ; core/html?: SettingsPropertiesComplete ; core/image?: SettingsPropertiesComplete ; core/latest-comments?: SettingsPropertiesComplete ; core/latest-posts?: SettingsPropertiesComplete ; core/legacy-widget?: SettingsPropertiesComplete ; core/list?: SettingsPropertiesComplete ; core/loginout?: SettingsPropertiesComplete ; core/media-text?: SettingsPropertiesComplete ; core/missing?: SettingsPropertiesComplete ; core/more?: SettingsPropertiesComplete ; core/navigation?: SettingsPropertiesComplete ; core/navigation-link?: SettingsPropertiesComplete ; core/nextpage?: SettingsPropertiesComplete ; core/page-list?: SettingsPropertiesComplete ; core/paragraph?: SettingsPropertiesComplete ; core/post-author?: SettingsPropertiesComplete ; core/post-comments?: SettingsPropertiesComplete ; core/post-comments-count?: SettingsPropertiesComplete ; core/post-comments-form?: SettingsPropertiesComplete ; core/post-comments-link?: SettingsPropertiesComplete ; core/post-content?: SettingsPropertiesComplete ; core/post-date?: SettingsPropertiesComplete ; core/post-excerpt?: SettingsPropertiesComplete ; core/post-featured-image?: SettingsPropertiesComplete ; core/post-navigation-link?: SettingsPropertiesComplete ; core/post-template?: SettingsPropertiesComplete ; core/post-terms?: SettingsPropertiesComplete ; core/post-title?: SettingsPropertiesComplete ; core/preformatted?: SettingsPropertiesComplete ; core/pullquote?: SettingsPropertiesComplete ; core/query?: SettingsPropertiesComplete ; core/query-pagination?: SettingsPropertiesComplete ; core/query-pagination-next?: SettingsPropertiesComplete ; core/query-pagination-numbers?: SettingsPropertiesComplete ; core/query-pagination-previous?: SettingsPropertiesComplete ; core/query-title?: SettingsPropertiesComplete ; core/quote?: SettingsPropertiesComplete ; core/rss?: SettingsPropertiesComplete ; core/search?: SettingsPropertiesComplete ; core/separator?: SettingsPropertiesComplete ; core/shortcode?: SettingsPropertiesComplete ; core/site-logo?: SettingsPropertiesComplete ; core/site-tagline?: SettingsPropertiesComplete ; core/site-title?: SettingsPropertiesComplete ; core/social-link?: SettingsPropertiesComplete ; core/social-links?: SettingsPropertiesComplete ; core/spacer?: SettingsPropertiesComplete ; core/table?: SettingsPropertiesComplete ; core/table-of-contents?: SettingsPropertiesComplete ; core/tag-cloud?: SettingsPropertiesComplete ; core/template-part?: SettingsPropertiesComplete ; core/term-description?: SettingsPropertiesComplete ; core/text-columns?: SettingsPropertiesComplete ; core/verse?: SettingsPropertiesComplete ; core/video?: SettingsPropertiesComplete ; core/widget-area?: SettingsPropertiesComplete ; core/widget-group?: SettingsPropertiesComplete } ; border?: { color?: boolean ; radius?: boolean ; style?: boolean ; width?: boolean } ; color?: { background?: boolean ; custom?: boolean ; customDuotone?: boolean ; customGradient?: boolean ; defaultGradients?: boolean ; defaultPalette?: boolean ; duotone?: SettingsDuotone ; gradients?: SettingsGradient ; link?: boolean ; palette?: SettingsColorPalette ; text?: boolean } ; custom?: { [k: string]: string | number | SettingsCustomAdditionalProperties; } ; layout?: { contentSize?: string ; wideSize?: string } ; spacing?: { blockGap?: null | boolean ; margin?: boolean ; padding?: boolean ; units?: string[] } ; typography?: { customFontSize?: boolean ; dropCap?: boolean ; fontFamilies?: { fontFamily?: string ; name?: string ; slug?: string }[] ; fontSizes?: { name?: string ; size?: string ; slug?: string }[] ; fontStyle?: boolean ; fontWeight?: boolean ; letterSpacing?: boolean ; lineHeight?: boolean ; textDecoration?: boolean ; textTransform?: boolean } }

Settings for the block editor and individual blocks. These include things like:

  • Which customization options should be available to the user.
  • The default colors, font sizes... available to the user.
  • CSS custom properties and class names used in styles.
  • And the default layout of the editor (widths and available alignments).

Defined in

packages/core/src/react/provider/types.ts:111


styles

Optional styles: StylesProperties & { blocks?: { core/archives?: StylesPropertiesAndElementsComplete ; core/audio?: StylesPropertiesAndElementsComplete ; core/block?: StylesPropertiesAndElementsComplete ; core/button?: StylesPropertiesAndElementsComplete ; core/buttons?: StylesPropertiesAndElementsComplete ; core/calendar?: StylesPropertiesAndElementsComplete ; core/categories?: StylesPropertiesAndElementsComplete ; core/code?: StylesPropertiesAndElementsComplete ; core/column?: StylesPropertiesAndElementsComplete ; core/columns?: StylesPropertiesAndElementsComplete ; core/comment-author-avatar?: StylesPropertiesAndElementsComplete ; core/comment-author-name?: StylesPropertiesAndElementsComplete ; core/comment-content?: StylesPropertiesAndElementsComplete ; core/comment-date?: StylesPropertiesAndElementsComplete ; core/comment-edit-link?: StylesPropertiesAndElementsComplete ; core/comment-reply-link?: StylesPropertiesAndElementsComplete ; core/comment-template?: StylesPropertiesAndElementsComplete ; core/comments-query-loop?: StylesPropertiesAndElementsComplete ; core/cover?: StylesPropertiesAndElementsComplete ; core/embed?: StylesPropertiesAndElementsComplete ; core/file?: StylesPropertiesAndElementsComplete ; core/freeform?: StylesPropertiesAndElementsComplete ; core/gallery?: StylesPropertiesAndElementsComplete ; core/group?: StylesPropertiesAndElementsComplete ; core/heading?: StylesPropertiesAndElementsComplete ; core/home-link?: StylesPropertiesAndElementsComplete ; core/html?: StylesPropertiesAndElementsComplete ; core/image?: StylesPropertiesAndElementsComplete ; core/latest-comments?: StylesPropertiesAndElementsComplete ; core/latest-posts?: StylesPropertiesAndElementsComplete ; core/legacy-widget?: StylesPropertiesAndElementsComplete ; core/list?: StylesPropertiesAndElementsComplete ; core/loginout?: StylesPropertiesAndElementsComplete ; core/media-text?: StylesPropertiesAndElementsComplete ; core/missing?: StylesPropertiesAndElementsComplete ; core/more?: StylesPropertiesAndElementsComplete ; core/navigation?: StylesPropertiesAndElementsComplete ; core/navigation-link?: StylesPropertiesAndElementsComplete ; core/nextpage?: StylesPropertiesAndElementsComplete ; core/page-list?: StylesPropertiesAndElementsComplete ; core/paragraph?: StylesPropertiesAndElementsComplete ; core/post-author?: StylesPropertiesAndElementsComplete ; core/post-comments?: StylesPropertiesAndElementsComplete ; core/post-comments-count?: StylesPropertiesAndElementsComplete ; core/post-comments-form?: StylesPropertiesAndElementsComplete ; core/post-comments-link?: StylesPropertiesAndElementsComplete ; core/post-content?: StylesPropertiesAndElementsComplete ; core/post-date?: StylesPropertiesAndElementsComplete ; core/post-excerpt?: StylesPropertiesAndElementsComplete ; core/post-featured-image?: StylesPropertiesAndElementsComplete ; core/post-navigation-link?: StylesPropertiesAndElementsComplete ; core/post-template?: StylesPropertiesAndElementsComplete ; core/post-terms?: StylesPropertiesAndElementsComplete ; core/post-title?: StylesPropertiesAndElementsComplete ; core/preformatted?: StylesPropertiesAndElementsComplete ; core/pullquote?: StylesPropertiesAndElementsComplete ; core/query?: StylesPropertiesAndElementsComplete ; core/query-pagination?: StylesPropertiesAndElementsComplete ; core/query-pagination-next?: StylesPropertiesAndElementsComplete ; core/query-pagination-numbers?: StylesPropertiesAndElementsComplete ; core/query-pagination-previous?: StylesPropertiesAndElementsComplete ; core/query-title?: StylesPropertiesAndElementsComplete ; core/quote?: StylesPropertiesAndElementsComplete ; core/rss?: StylesPropertiesAndElementsComplete ; core/search?: StylesPropertiesAndElementsComplete ; core/separator?: StylesPropertiesAndElementsComplete ; core/shortcode?: StylesPropertiesAndElementsComplete ; core/site-logo?: StylesPropertiesAndElementsComplete ; core/site-tagline?: StylesPropertiesAndElementsComplete ; core/site-title?: StylesPropertiesAndElementsComplete ; core/social-link?: StylesPropertiesAndElementsComplete ; core/social-links?: StylesPropertiesAndElementsComplete ; core/spacer?: StylesPropertiesAndElementsComplete ; core/table?: StylesPropertiesAndElementsComplete ; core/table-of-contents?: StylesPropertiesAndElementsComplete ; core/tag-cloud?: StylesPropertiesAndElementsComplete ; core/template-part?: StylesPropertiesAndElementsComplete ; core/term-description?: StylesPropertiesAndElementsComplete ; core/text-columns?: StylesPropertiesAndElementsComplete ; core/verse?: StylesPropertiesAndElementsComplete ; core/video?: StylesPropertiesAndElementsComplete ; core/widget-area?: StylesPropertiesAndElementsComplete ; core/widget-group?: StylesPropertiesAndElementsComplete } ; border?: unknown ; color?: unknown ; elements?: { h1?: StylesPropertiesComplete ; h2?: StylesPropertiesComplete ; h3?: StylesPropertiesComplete ; h4?: StylesPropertiesComplete ; h5?: StylesPropertiesComplete ; h6?: StylesPropertiesComplete ; link?: StylesPropertiesComplete } ; spacing?: unknown ; typography?: unknown }

Organized way to set CSS properties. Styles in the top-level will be added in the body selector.

Defined in

packages/core/src/react/provider/types.ts:210


templateParts

Optional templateParts: { area?: string ; name: string ; title?: string }[]

Additional metadata for template parts defined in the parts folder.

Defined in

packages/core/src/react/provider/types.ts:336


version

version: 2

Version of theme.json to use.

Defined in

packages/core/src/react/provider/types.ts:103

- +
Skip to main content

Interface: WpThemeJSON

@headstartwp/core.react.WpThemeJSON

Properties

$schema

Optional $schema: string

JSON schema URI for theme.json.

Defined in

packages/core/src/react/provider/types.ts:99


customTemplates

Optional customTemplates: { name: string ; postTypes?: string[] ; title: string }[]

Additional metadata for custom templates defined in the templates folder.

Defined in

packages/core/src/react/provider/types.ts:319


settings

Optional settings: SettingsProperties & { blocks?: { core/archives?: SettingsPropertiesComplete ; core/audio?: SettingsPropertiesComplete ; core/block?: SettingsPropertiesComplete ; core/button?: SettingsPropertiesComplete ; core/buttons?: SettingsPropertiesComplete ; core/calendar?: SettingsPropertiesComplete ; core/categories?: SettingsPropertiesComplete ; core/code?: SettingsPropertiesComplete ; core/column?: SettingsPropertiesComplete ; core/columns?: SettingsPropertiesComplete ; core/comment-author-avatar?: SettingsPropertiesComplete ; core/comment-author-name?: SettingsPropertiesComplete ; core/comment-content?: SettingsPropertiesComplete ; core/comment-date?: SettingsPropertiesComplete ; core/comment-edit-link?: SettingsPropertiesComplete ; core/comment-reply-link?: SettingsPropertiesComplete ; core/comment-template?: SettingsPropertiesComplete ; core/comments-query-loop?: SettingsPropertiesComplete ; core/cover?: SettingsPropertiesComplete ; core/embed?: SettingsPropertiesComplete ; core/file?: SettingsPropertiesComplete ; core/freeform?: SettingsPropertiesComplete ; core/gallery?: SettingsPropertiesComplete ; core/group?: SettingsPropertiesComplete ; core/heading?: SettingsPropertiesComplete ; core/home-link?: SettingsPropertiesComplete ; core/html?: SettingsPropertiesComplete ; core/image?: SettingsPropertiesComplete ; core/latest-comments?: SettingsPropertiesComplete ; core/latest-posts?: SettingsPropertiesComplete ; core/legacy-widget?: SettingsPropertiesComplete ; core/list?: SettingsPropertiesComplete ; core/loginout?: SettingsPropertiesComplete ; core/media-text?: SettingsPropertiesComplete ; core/missing?: SettingsPropertiesComplete ; core/more?: SettingsPropertiesComplete ; core/navigation?: SettingsPropertiesComplete ; core/navigation-link?: SettingsPropertiesComplete ; core/nextpage?: SettingsPropertiesComplete ; core/page-list?: SettingsPropertiesComplete ; core/paragraph?: SettingsPropertiesComplete ; core/post-author?: SettingsPropertiesComplete ; core/post-comments?: SettingsPropertiesComplete ; core/post-comments-count?: SettingsPropertiesComplete ; core/post-comments-form?: SettingsPropertiesComplete ; core/post-comments-link?: SettingsPropertiesComplete ; core/post-content?: SettingsPropertiesComplete ; core/post-date?: SettingsPropertiesComplete ; core/post-excerpt?: SettingsPropertiesComplete ; core/post-featured-image?: SettingsPropertiesComplete ; core/post-navigation-link?: SettingsPropertiesComplete ; core/post-template?: SettingsPropertiesComplete ; core/post-terms?: SettingsPropertiesComplete ; core/post-title?: SettingsPropertiesComplete ; core/preformatted?: SettingsPropertiesComplete ; core/pullquote?: SettingsPropertiesComplete ; core/query?: SettingsPropertiesComplete ; core/query-pagination?: SettingsPropertiesComplete ; core/query-pagination-next?: SettingsPropertiesComplete ; core/query-pagination-numbers?: SettingsPropertiesComplete ; core/query-pagination-previous?: SettingsPropertiesComplete ; core/query-title?: SettingsPropertiesComplete ; core/quote?: SettingsPropertiesComplete ; core/rss?: SettingsPropertiesComplete ; core/search?: SettingsPropertiesComplete ; core/separator?: SettingsPropertiesComplete ; core/shortcode?: SettingsPropertiesComplete ; core/site-logo?: SettingsPropertiesComplete ; core/site-tagline?: SettingsPropertiesComplete ; core/site-title?: SettingsPropertiesComplete ; core/social-link?: SettingsPropertiesComplete ; core/social-links?: SettingsPropertiesComplete ; core/spacer?: SettingsPropertiesComplete ; core/table?: SettingsPropertiesComplete ; core/table-of-contents?: SettingsPropertiesComplete ; core/tag-cloud?: SettingsPropertiesComplete ; core/template-part?: SettingsPropertiesComplete ; core/term-description?: SettingsPropertiesComplete ; core/text-columns?: SettingsPropertiesComplete ; core/verse?: SettingsPropertiesComplete ; core/video?: SettingsPropertiesComplete ; core/widget-area?: SettingsPropertiesComplete ; core/widget-group?: SettingsPropertiesComplete } ; border?: { color?: boolean ; radius?: boolean ; style?: boolean ; width?: boolean } ; color?: { background?: boolean ; custom?: boolean ; customDuotone?: boolean ; customGradient?: boolean ; defaultGradients?: boolean ; defaultPalette?: boolean ; duotone?: SettingsDuotone ; gradients?: SettingsGradient ; link?: boolean ; palette?: SettingsColorPalette ; text?: boolean } ; custom?: { [k: string]: string | number | SettingsCustomAdditionalProperties; } ; layout?: { contentSize?: string ; wideSize?: string } ; spacing?: { blockGap?: null | boolean ; margin?: boolean ; padding?: boolean ; units?: string[] } ; typography?: { customFontSize?: boolean ; dropCap?: boolean ; fontFamilies?: { fontFamily?: string ; name?: string ; slug?: string }[] ; fontSizes?: { name?: string ; size?: string ; slug?: string }[] ; fontStyle?: boolean ; fontWeight?: boolean ; letterSpacing?: boolean ; lineHeight?: boolean ; textDecoration?: boolean ; textTransform?: boolean } }

Settings for the block editor and individual blocks. These include things like:

  • Which customization options should be available to the user.
  • The default colors, font sizes... available to the user.
  • CSS custom properties and class names used in styles.
  • And the default layout of the editor (widths and available alignments).

Defined in

packages/core/src/react/provider/types.ts:111


styles

Optional styles: StylesProperties & { blocks?: { core/archives?: StylesPropertiesAndElementsComplete ; core/audio?: StylesPropertiesAndElementsComplete ; core/block?: StylesPropertiesAndElementsComplete ; core/button?: StylesPropertiesAndElementsComplete ; core/buttons?: StylesPropertiesAndElementsComplete ; core/calendar?: StylesPropertiesAndElementsComplete ; core/categories?: StylesPropertiesAndElementsComplete ; core/code?: StylesPropertiesAndElementsComplete ; core/column?: StylesPropertiesAndElementsComplete ; core/columns?: StylesPropertiesAndElementsComplete ; core/comment-author-avatar?: StylesPropertiesAndElementsComplete ; core/comment-author-name?: StylesPropertiesAndElementsComplete ; core/comment-content?: StylesPropertiesAndElementsComplete ; core/comment-date?: StylesPropertiesAndElementsComplete ; core/comment-edit-link?: StylesPropertiesAndElementsComplete ; core/comment-reply-link?: StylesPropertiesAndElementsComplete ; core/comment-template?: StylesPropertiesAndElementsComplete ; core/comments-query-loop?: StylesPropertiesAndElementsComplete ; core/cover?: StylesPropertiesAndElementsComplete ; core/embed?: StylesPropertiesAndElementsComplete ; core/file?: StylesPropertiesAndElementsComplete ; core/freeform?: StylesPropertiesAndElementsComplete ; core/gallery?: StylesPropertiesAndElementsComplete ; core/group?: StylesPropertiesAndElementsComplete ; core/heading?: StylesPropertiesAndElementsComplete ; core/home-link?: StylesPropertiesAndElementsComplete ; core/html?: StylesPropertiesAndElementsComplete ; core/image?: StylesPropertiesAndElementsComplete ; core/latest-comments?: StylesPropertiesAndElementsComplete ; core/latest-posts?: StylesPropertiesAndElementsComplete ; core/legacy-widget?: StylesPropertiesAndElementsComplete ; core/list?: StylesPropertiesAndElementsComplete ; core/loginout?: StylesPropertiesAndElementsComplete ; core/media-text?: StylesPropertiesAndElementsComplete ; core/missing?: StylesPropertiesAndElementsComplete ; core/more?: StylesPropertiesAndElementsComplete ; core/navigation?: StylesPropertiesAndElementsComplete ; core/navigation-link?: StylesPropertiesAndElementsComplete ; core/nextpage?: StylesPropertiesAndElementsComplete ; core/page-list?: StylesPropertiesAndElementsComplete ; core/paragraph?: StylesPropertiesAndElementsComplete ; core/post-author?: StylesPropertiesAndElementsComplete ; core/post-comments?: StylesPropertiesAndElementsComplete ; core/post-comments-count?: StylesPropertiesAndElementsComplete ; core/post-comments-form?: StylesPropertiesAndElementsComplete ; core/post-comments-link?: StylesPropertiesAndElementsComplete ; core/post-content?: StylesPropertiesAndElementsComplete ; core/post-date?: StylesPropertiesAndElementsComplete ; core/post-excerpt?: StylesPropertiesAndElementsComplete ; core/post-featured-image?: StylesPropertiesAndElementsComplete ; core/post-navigation-link?: StylesPropertiesAndElementsComplete ; core/post-template?: StylesPropertiesAndElementsComplete ; core/post-terms?: StylesPropertiesAndElementsComplete ; core/post-title?: StylesPropertiesAndElementsComplete ; core/preformatted?: StylesPropertiesAndElementsComplete ; core/pullquote?: StylesPropertiesAndElementsComplete ; core/query?: StylesPropertiesAndElementsComplete ; core/query-pagination?: StylesPropertiesAndElementsComplete ; core/query-pagination-next?: StylesPropertiesAndElementsComplete ; core/query-pagination-numbers?: StylesPropertiesAndElementsComplete ; core/query-pagination-previous?: StylesPropertiesAndElementsComplete ; core/query-title?: StylesPropertiesAndElementsComplete ; core/quote?: StylesPropertiesAndElementsComplete ; core/rss?: StylesPropertiesAndElementsComplete ; core/search?: StylesPropertiesAndElementsComplete ; core/separator?: StylesPropertiesAndElementsComplete ; core/shortcode?: StylesPropertiesAndElementsComplete ; core/site-logo?: StylesPropertiesAndElementsComplete ; core/site-tagline?: StylesPropertiesAndElementsComplete ; core/site-title?: StylesPropertiesAndElementsComplete ; core/social-link?: StylesPropertiesAndElementsComplete ; core/social-links?: StylesPropertiesAndElementsComplete ; core/spacer?: StylesPropertiesAndElementsComplete ; core/table?: StylesPropertiesAndElementsComplete ; core/table-of-contents?: StylesPropertiesAndElementsComplete ; core/tag-cloud?: StylesPropertiesAndElementsComplete ; core/template-part?: StylesPropertiesAndElementsComplete ; core/term-description?: StylesPropertiesAndElementsComplete ; core/text-columns?: StylesPropertiesAndElementsComplete ; core/verse?: StylesPropertiesAndElementsComplete ; core/video?: StylesPropertiesAndElementsComplete ; core/widget-area?: StylesPropertiesAndElementsComplete ; core/widget-group?: StylesPropertiesAndElementsComplete } ; border?: unknown ; color?: unknown ; elements?: { h1?: StylesPropertiesComplete ; h2?: StylesPropertiesComplete ; h3?: StylesPropertiesComplete ; h4?: StylesPropertiesComplete ; h5?: StylesPropertiesComplete ; h6?: StylesPropertiesComplete ; link?: StylesPropertiesComplete } ; spacing?: unknown ; typography?: unknown }

Organized way to set CSS properties. Styles in the top-level will be added in the body selector.

Defined in

packages/core/src/react/provider/types.ts:210


templateParts

Optional templateParts: { area?: string ; name: string ; title?: string }[]

Additional metadata for template parts defined in the parts folder.

Defined in

packages/core/src/react/provider/types.ts:336


version

version: 2

Version of theme.json to use.

Defined in

packages/core/src/react/provider/types.ts:103

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps/index.html b/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps/index.html index f37f7704f..1be09d5fd 100644 --- a/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: YoutubeLiteBlockProps

@headstartwp/core.react.YoutubeLiteBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


src

src: string

Defined in

packages/core/src/react/blocks/YoutubeLiteBlock.tsx:29


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74


title

title: string

Defined in

packages/core/src/react/blocks/YoutubeLiteBlock.tsx:30

- +
Skip to main content

Interface: YoutubeLiteBlockProps

@headstartwp/core.react.YoutubeLiteBlockProps

Hierarchy

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/src/react/blocks/types.ts:79


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/src/react/blocks/types.ts:77


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/src/react/blocks/types.ts:73


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/src/react/blocks/types.ts:75


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/src/react/blocks/types.ts:76


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/src/react/blocks/types.ts:72


src

src: string

Defined in

packages/core/src/react/blocks/YoutubeLiteBlock.tsx:29


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/src/react/blocks/types.ts:74


title

title: string

Defined in

packages/core/src/react/blocks/YoutubeLiteBlock.tsx:30

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.useAppSettingsResponse/index.html b/api/interfaces/headstartwp_core.react.useAppSettingsResponse/index.html index 0948b5cb3..6e29c2599 100644 --- a/api/interfaces/headstartwp_core.react.useAppSettingsResponse/index.html +++ b/api/interfaces/headstartwp_core.react.useAppSettingsResponse/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: useAppSettingsResponse<T>

@headstartwp/core.react.useAppSettingsResponse

Type parameters

NameType
Textends AppEntity

Hierarchy

Properties

data

Optional data: T

Overrides

HookResponse.data

Defined in

packages/core/src/react/hooks/useFetchAppSettings.ts:8


error

Optional error: string

Inherited from

HookResponse.error

Defined in

packages/core/src/react/hooks/types.ts:6


isMainQuery

isMainQuery: boolean

Inherited from

HookResponse.isMainQuery

Defined in

packages/core/src/react/hooks/types.ts:8


loading

loading: boolean

Inherited from

HookResponse.loading

Defined in

packages/core/src/react/hooks/types.ts:7

- +
Skip to main content

Interface: useAppSettingsResponse<T>

@headstartwp/core.react.useAppSettingsResponse

Type parameters

NameType
Textends AppEntity

Hierarchy

Properties

data

Optional data: T

Overrides

HookResponse.data

Defined in

packages/core/src/react/hooks/useFetchAppSettings.ts:8


error

Optional error: string

Inherited from

HookResponse.error

Defined in

packages/core/src/react/hooks/types.ts:6


isMainQuery

isMainQuery: boolean

Inherited from

HookResponse.isMainQuery

Defined in

packages/core/src/react/hooks/types.ts:8


loading

loading: boolean

Inherited from

HookResponse.loading

Defined in

packages/core/src/react/hooks/types.ts:7

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.useFetchOptions/index.html b/api/interfaces/headstartwp_core.react.useFetchOptions/index.html index cffd184e9..4d194f51c 100644 --- a/api/interfaces/headstartwp_core.react.useFetchOptions/index.html +++ b/api/interfaces/headstartwp_core.react.useFetchOptions/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content
- +
Skip to main content
+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.useMenuResponse/index.html b/api/interfaces/headstartwp_core.react.useMenuResponse/index.html index d18ceb15d..635d4c51f 100644 --- a/api/interfaces/headstartwp_core.react.useMenuResponse/index.html +++ b/api/interfaces/headstartwp_core.react.useMenuResponse/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: useMenuResponse

@headstartwp/core.react.useMenuResponse

Hierarchy

Properties

data

Optional data: MenuItemEntity[]

Overrides

HookResponse.data

Defined in

packages/core/src/react/hooks/useFetchMenu.ts:7


error

Optional error: string

Inherited from

HookResponse.error

Defined in

packages/core/src/react/hooks/types.ts:6


isMainQuery

isMainQuery: boolean

Inherited from

HookResponse.isMainQuery

Defined in

packages/core/src/react/hooks/types.ts:8


loading

loading: boolean

Inherited from

HookResponse.loading

Defined in

packages/core/src/react/hooks/types.ts:7

- +
Skip to main content

Interface: useMenuResponse

@headstartwp/core.react.useMenuResponse

Hierarchy

Properties

data

Optional data: MenuItemEntity[]

Overrides

HookResponse.data

Defined in

packages/core/src/react/hooks/useFetchMenu.ts:7


error

Optional error: string

Inherited from

HookResponse.error

Defined in

packages/core/src/react/hooks/types.ts:6


isMainQuery

isMainQuery: boolean

Inherited from

HookResponse.isMainQuery

Defined in

packages/core/src/react/hooks/types.ts:8


loading

loading: boolean

Inherited from

HookResponse.loading

Defined in

packages/core/src/react/hooks/types.ts:7

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.usePostOrPostResponse/index.html b/api/interfaces/headstartwp_core.react.usePostOrPostResponse/index.html index c112ebb9b..2b2db0212 100644 --- a/api/interfaces/headstartwp_core.react.usePostOrPostResponse/index.html +++ b/api/interfaces/headstartwp_core.react.usePostOrPostResponse/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: usePostOrPostResponse<T>

@headstartwp/core.react.usePostOrPostResponse

Type parameters

NameType
Textends PostEntity = PostEntity

Hierarchy

Properties

data

Optional data: Object

Type declaration

NameType
post?T
posts?T[]

Overrides

HookResponse.data

Defined in

packages/core/src/react/hooks/useFetchPostOrPosts.ts:15


error

Optional error: string

Inherited from

HookResponse.error

Defined in

packages/core/src/react/hooks/types.ts:6


isArchive

isArchive: boolean

Defined in

packages/core/src/react/hooks/useFetchPostOrPosts.ts:17


isMainQuery

isMainQuery: boolean

Inherited from

HookResponse.isMainQuery

Defined in

packages/core/src/react/hooks/types.ts:8


isSingle

isSingle: boolean

Defined in

packages/core/src/react/hooks/useFetchPostOrPosts.ts:16


loading

loading: boolean

Inherited from

HookResponse.loading

Defined in

packages/core/src/react/hooks/types.ts:7

- +
Skip to main content

Interface: usePostOrPostResponse<T>

@headstartwp/core.react.usePostOrPostResponse

Type parameters

NameType
Textends PostEntity = PostEntity

Hierarchy

Properties

data

Optional data: Object

Type declaration

NameType
post?T
posts?T[]

Overrides

HookResponse.data

Defined in

packages/core/src/react/hooks/useFetchPostOrPosts.ts:15


error

Optional error: string

Inherited from

HookResponse.error

Defined in

packages/core/src/react/hooks/types.ts:6


isArchive

isArchive: boolean

Defined in

packages/core/src/react/hooks/useFetchPostOrPosts.ts:17


isMainQuery

isMainQuery: boolean

Inherited from

HookResponse.isMainQuery

Defined in

packages/core/src/react/hooks/types.ts:8


isSingle

isSingle: boolean

Defined in

packages/core/src/react/hooks/useFetchPostOrPosts.ts:16


loading

loading: boolean

Inherited from

HookResponse.loading

Defined in

packages/core/src/react/hooks/types.ts:7

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.usePostResponse/index.html b/api/interfaces/headstartwp_core.react.usePostResponse/index.html index 6f5dae17c..014f17bb4 100644 --- a/api/interfaces/headstartwp_core.react.usePostResponse/index.html +++ b/api/interfaces/headstartwp_core.react.usePostResponse/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: usePostResponse<T>

@headstartwp/core.react.usePostResponse

Type parameters

NameType
Textends PostEntity = PostEntity

Hierarchy

Properties

data

Optional data: Object

Type declaration

NameType
postT

Overrides

HookResponse.data

Defined in

packages/core/src/react/hooks/useFetchPost.ts:15


error

Optional error: string

Inherited from

HookResponse.error

Defined in

packages/core/src/react/hooks/types.ts:6


isMainQuery

isMainQuery: boolean

Inherited from

HookResponse.isMainQuery

Defined in

packages/core/src/react/hooks/types.ts:8


loading

loading: boolean

Inherited from

HookResponse.loading

Defined in

packages/core/src/react/hooks/types.ts:7

- +
Skip to main content

Interface: usePostResponse<T>

@headstartwp/core.react.usePostResponse

Type parameters

NameType
Textends PostEntity = PostEntity

Hierarchy

Properties

data

Optional data: Object

Type declaration

NameType
postT

Overrides

HookResponse.data

Defined in

packages/core/src/react/hooks/useFetchPost.ts:15


error

Optional error: string

Inherited from

HookResponse.error

Defined in

packages/core/src/react/hooks/types.ts:6


isMainQuery

isMainQuery: boolean

Inherited from

HookResponse.isMainQuery

Defined in

packages/core/src/react/hooks/types.ts:8


loading

loading: boolean

Inherited from

HookResponse.loading

Defined in

packages/core/src/react/hooks/types.ts:7

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.usePostsResponse/index.html b/api/interfaces/headstartwp_core.react.usePostsResponse/index.html index 97a547ebf..8d3a79e2d 100644 --- a/api/interfaces/headstartwp_core.react.usePostsResponse/index.html +++ b/api/interfaces/headstartwp_core.react.usePostsResponse/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: usePostsResponse<T>

@headstartwp/core.react.usePostsResponse

Type parameters

NameType
Textends PostEntity = PostEntity

Hierarchy

Properties

data

Optional data: Object

Type declaration

NameType
pageInfoPageInfo
postsT[]
queriedObjectQueriedObject

Overrides

HookResponse.data

Defined in

packages/core/src/react/hooks/useFetchPosts.ts:59


error

Optional error: string

Inherited from

HookResponse.error

Defined in

packages/core/src/react/hooks/types.ts:6


isMainQuery

isMainQuery: boolean

Inherited from

HookResponse.isMainQuery

Defined in

packages/core/src/react/hooks/types.ts:8


loading

loading: boolean

Inherited from

HookResponse.loading

Defined in

packages/core/src/react/hooks/types.ts:7


pageType

pageType: PageType

Defined in

packages/core/src/react/hooks/useFetchPosts.ts:64

- +
Skip to main content

Interface: usePostsResponse<T>

@headstartwp/core.react.usePostsResponse

Type parameters

NameType
Textends PostEntity = PostEntity

Hierarchy

Properties

data

Optional data: Object

Type declaration

NameType
pageInfoPageInfo
postsT[]
queriedObjectQueriedObject

Overrides

HookResponse.data

Defined in

packages/core/src/react/hooks/useFetchPosts.ts:59


error

Optional error: string

Inherited from

HookResponse.error

Defined in

packages/core/src/react/hooks/types.ts:6


isMainQuery

isMainQuery: boolean

Inherited from

HookResponse.isMainQuery

Defined in

packages/core/src/react/hooks/types.ts:8


loading

loading: boolean

Inherited from

HookResponse.loading

Defined in

packages/core/src/react/hooks/types.ts:7


pageType

pageType: PageType

Defined in

packages/core/src/react/hooks/useFetchPosts.ts:64

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.useSearchResponse/index.html b/api/interfaces/headstartwp_core.react.useSearchResponse/index.html index a87ac667b..8822aec4f 100644 --- a/api/interfaces/headstartwp_core.react.useSearchResponse/index.html +++ b/api/interfaces/headstartwp_core.react.useSearchResponse/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: useSearchResponse<T>

@headstartwp/core.react.useSearchResponse

Type parameters

NameType
Textends PostEntity = PostEntity

Hierarchy

Properties

data

Optional data: Object

Type declaration

NameType
pageInfoPageInfo
postsT[]
queriedObjectQueriedObject

Overrides

HookResponse.data

Defined in

packages/core/src/react/hooks/useFetchSearch.ts:18


error

Optional error: string

Inherited from

HookResponse.error

Defined in

packages/core/src/react/hooks/types.ts:6


isMainQuery

isMainQuery: boolean

Inherited from

HookResponse.isMainQuery

Defined in

packages/core/src/react/hooks/types.ts:8


loading

loading: boolean

Inherited from

HookResponse.loading

Defined in

packages/core/src/react/hooks/types.ts:7

- +
Skip to main content

Interface: useSearchResponse<T>

@headstartwp/core.react.useSearchResponse

Type parameters

NameType
Textends PostEntity = PostEntity

Hierarchy

Properties

data

Optional data: Object

Type declaration

NameType
pageInfoPageInfo
postsT[]
queriedObjectQueriedObject

Overrides

HookResponse.data

Defined in

packages/core/src/react/hooks/useFetchSearch.ts:18


error

Optional error: string

Inherited from

HookResponse.error

Defined in

packages/core/src/react/hooks/types.ts:6


isMainQuery

isMainQuery: boolean

Inherited from

HookResponse.isMainQuery

Defined in

packages/core/src/react/hooks/types.ts:8


loading

loading: boolean

Inherited from

HookResponse.loading

Defined in

packages/core/src/react/hooks/types.ts:7

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.useTermsResponse/index.html b/api/interfaces/headstartwp_core.react.useTermsResponse/index.html index 827f02575..0e3d76e39 100644 --- a/api/interfaces/headstartwp_core.react.useTermsResponse/index.html +++ b/api/interfaces/headstartwp_core.react.useTermsResponse/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: useTermsResponse<T>

@headstartwp/core.react.useTermsResponse

Type parameters

NameType
Textends TermEntity

Hierarchy

Properties

data

Optional data: Object

Type declaration

NameType
pageInfoPageInfo
termsT[]

Overrides

HookResponse.data

Defined in

packages/core/src/react/hooks/useFetchTerms.ts:15


error

Optional error: string

Inherited from

HookResponse.error

Defined in

packages/core/src/react/hooks/types.ts:6


isMainQuery

isMainQuery: boolean

Inherited from

HookResponse.isMainQuery

Defined in

packages/core/src/react/hooks/types.ts:8


loading

loading: boolean

Inherited from

HookResponse.loading

Defined in

packages/core/src/react/hooks/types.ts:7

- +
Skip to main content

Interface: useTermsResponse<T>

@headstartwp/core.react.useTermsResponse

Type parameters

NameType
Textends TermEntity

Hierarchy

Properties

data

Optional data: Object

Type declaration

NameType
pageInfoPageInfo
termsT[]

Overrides

HookResponse.data

Defined in

packages/core/src/react/hooks/useFetchTerms.ts:15


error

Optional error: string

Inherited from

HookResponse.error

Defined in

packages/core/src/react/hooks/types.ts:6


isMainQuery

isMainQuery: boolean

Inherited from

HookResponse.isMainQuery

Defined in

packages/core/src/react/hooks/types.ts:8


loading

loading: boolean

Inherited from

HookResponse.loading

Defined in

packages/core/src/react/hooks/types.ts:7

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_next.FetchHookDataOptions/index.html b/api/interfaces/headstartwp_next.FetchHookDataOptions/index.html index b153aeec4..f7e9e7d9f 100644 --- a/api/interfaces/headstartwp_next.FetchHookDataOptions/index.html +++ b/api/interfaces/headstartwp_next.FetchHookDataOptions/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: FetchHookDataOptions<P, T>

@headstartwp/next.FetchHookDataOptions

The supported options for fetchHookData

Type parameters

NameType
Punknown
Tunknown

Properties

fetchStrategyOptions

Optional fetchStrategyOptions: FetchOptions

Optional. If set, will forward fetch options to the fetch strategy

Defined in

packages/next/src/data/server/fetchHookData.ts:34


filterData

Optional filterData: FilterDataOptions<T>

Optional. If set, the data will be filtered given FilterDataOptions

Defined in

packages/next/src/data/server/fetchHookData.ts:29


params

Optional params: P

This should match params passed to the hook on the client side.

Defined in

packages/next/src/data/server/fetchHookData.ts:24

- +
Skip to main content

Interface: FetchHookDataOptions<P, T>

@headstartwp/next.FetchHookDataOptions

The supported options for fetchHookData

Type parameters

NameType
Punknown
Tunknown

Properties

fetchStrategyOptions

Optional fetchStrategyOptions: FetchOptions

Optional. If set, will forward fetch options to the fetch strategy

Defined in

packages/next/src/data/server/fetchHookData.ts:34


filterData

Optional filterData: FilterDataOptions<T>

Optional. If set, the data will be filtered given FilterDataOptions

Defined in

packages/next/src/data/server/fetchHookData.ts:29


params

Optional params: P

This should match params passed to the hook on the client side.

Defined in

packages/next/src/data/server/fetchHookData.ts:24

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_next.ImageProps/index.html b/api/interfaces/headstartwp_next.ImageProps/index.html index d3f7347d8..0ab789426 100644 --- a/api/interfaces/headstartwp_next.ImageProps/index.html +++ b/api/interfaces/headstartwp_next.ImageProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: ImageProps

@headstartwp/next.ImageProps

Hierarchy

  • ImageBlockProps

    ImageProps

Properties

alt

Optional alt: string

Inherited from

ImageBlockProps.alt

Defined in

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:9


attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

ImageBlockProps.attributes

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:70


children

Optional children: ReactNode

Inherited from

ImageBlockProps.children

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:69


className

Optional className: string

Inherited from

ImageBlockProps.className

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:65


domNode

Optional domNode: Element

Inherited from

ImageBlockProps.domNode

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:67


height

Optional height: number

Inherited from

ImageBlockProps.height

Defined in

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:5


htmlAnchor

Optional htmlAnchor: string

Inherited from

ImageBlockProps.htmlAnchor

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:68


linkDestination

Optional linkDestination: string

Inherited from

ImageBlockProps.linkDestination

Defined in

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:7


loader

Optional loader: (props: ImageLoaderProps | VIPCustomImageLoader) => string

Type declaration

▸ (props): string

Parameters
NameType
propsImageLoaderProps | VIPCustomImageLoader
Returns

string

Defined in

packages/next/src/components/ImageComponent.tsx:75


name

name: string

Inherited from

ImageBlockProps.name

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:64


sizeSlug

Optional sizeSlug: string

Inherited from

ImageBlockProps.sizeSlug

Defined in

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:6


src

src: string

Inherited from

ImageBlockProps.src

Defined in

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:8


style

Optional style: Record<string, string>

Inherited from

ImageBlockProps.style

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:66


width

Optional width: number

Inherited from

ImageBlockProps.width

Defined in

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:4

- +
Skip to main content

Interface: ImageProps

@headstartwp/next.ImageProps

Hierarchy

  • ImageBlockProps

    ImageProps

Properties

alt

Optional alt: string

Inherited from

ImageBlockProps.alt

Defined in

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:9


attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

ImageBlockProps.attributes

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:70


children

Optional children: ReactNode

Inherited from

ImageBlockProps.children

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:69


className

Optional className: string

Inherited from

ImageBlockProps.className

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:65


domNode

Optional domNode: Element

Inherited from

ImageBlockProps.domNode

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:67


height

Optional height: number

Inherited from

ImageBlockProps.height

Defined in

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:5


htmlAnchor

Optional htmlAnchor: string

Inherited from

ImageBlockProps.htmlAnchor

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:68


linkDestination

Optional linkDestination: string

Inherited from

ImageBlockProps.linkDestination

Defined in

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:7


loader

Optional loader: (props: ImageLoaderProps | VIPCustomImageLoader) => string

Type declaration

▸ (props): string

Parameters
NameType
propsImageLoaderProps | VIPCustomImageLoader
Returns

string

Defined in

packages/next/src/components/ImageComponent.tsx:75


name

name: string

Inherited from

ImageBlockProps.name

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:64


sizeSlug

Optional sizeSlug: string

Inherited from

ImageBlockProps.sizeSlug

Defined in

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:6


src

src: string

Inherited from

ImageBlockProps.src

Defined in

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:8


style

Optional style: Record<string, string>

Inherited from

ImageBlockProps.style

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:66


width

Optional width: number

Inherited from

ImageBlockProps.width

Defined in

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:4

+ \ No newline at end of file diff --git a/api/interfaces/headstartwp_next.LinkBlockProps/index.html b/api/interfaces/headstartwp_next.LinkBlockProps/index.html index 986b8bc3e..98f5d1b3c 100644 --- a/api/interfaces/headstartwp_next.LinkBlockProps/index.html +++ b/api/interfaces/headstartwp_next.LinkBlockProps/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Interface: LinkBlockProps

@headstartwp/next.LinkBlockProps

Hierarchy

  • IBlockAttributes

    LinkBlockProps

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:70


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:69


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:65


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:67


href

href: string

Defined in

packages/next/src/blocks/LinkBlock.tsx:7


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:68


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:64


rel

rel: string

Defined in

packages/next/src/blocks/LinkBlock.tsx:8


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:66

- +
Skip to main content

Interface: LinkBlockProps

@headstartwp/next.LinkBlockProps

Hierarchy

  • IBlockAttributes

    LinkBlockProps

Properties

attributes

Optional attributes: Object

Type declaration

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from

IBlockAttributes.attributes

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:70


children

Optional children: ReactNode

Inherited from

IBlockAttributes.children

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:69


className

Optional className: string

Inherited from

IBlockAttributes.className

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:65


domNode

Optional domNode: Element

Inherited from

IBlockAttributes.domNode

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:67


href

href: string

Defined in

packages/next/src/blocks/LinkBlock.tsx:7


htmlAnchor

Optional htmlAnchor: string

Inherited from

IBlockAttributes.htmlAnchor

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:68


name

name: string

Inherited from

IBlockAttributes.name

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:64


rel

rel: string

Defined in

packages/next/src/blocks/LinkBlock.tsx:8


style

Optional style: Record<string, string>

Inherited from

IBlockAttributes.style

Defined in

packages/core/dist/mjs/react/blocks/types.d.ts:66

+ \ No newline at end of file diff --git a/api/modules/headstartwp_core/index.html b/api/modules/headstartwp_core/index.html index 69502ec19..573a34521 100644 --- a/api/modules/headstartwp_core/index.html +++ b/api/modules/headstartwp_core/index.html @@ -7,26 +7,26 @@ - +
Skip to main content

Module: @headstartwp/core

Namespaces

Enumerations

Classes

Interfaces

DOM Helpers

isAnchorTag

isAnchorTag(node, options?, site?): node is Element

Checks if the provided node is an valid anchor tag

This function expects to be used with DOMNode objects from html-react-parser, which is -the underlying parser used by BlocksRenderer.

Usage

import { isAnchorTag } from '@headstartwp/core';
import { LinkBlock } from '@10up/headless-next';

<BlocksRenderer html={html}>
<LinkBlock test={(node) => isAnchorTag(node, { isInternalLink: true})} />
</BlocksRenderer>

Parameters

NameTypeDefault valueDescription
nodeDOMNodeundefinedThe node to test
optionsisAnchorTagOptions{}Supported options
siteundefined | HeadlessConfigundefined

Returns

node is Element

Whether it's an anchor tag according to the options passed

Defined in

packages/core/src/dom/index.ts:77


isBlock

isBlock(node, _options): boolean

Tests a node by tagName and/or className

This function expects to be used with DOMNode objects from html-react-parser, which is -the underlying parser used by BlocksRenderer.

Usage

import { isBlock } from '@headstartwp/core';

<BlocksRenderer html={html}>
<MyCustomBlock
test={(node) => isBlock(node, { tagName: 'div', classList: ['block-class-name'] })}
/>
</BlocksRenderer>

Parameters

NameTypeDescription
nodeDOMNodeThe node to test
_optionsisBlockOptions

Returns

boolean

true if the node passes the test

Defined in

packages/core/src/dom/index.ts:278


isBlockByName

isBlockByName(node, name): boolean

Tests a node by block name. This requires the Headless WP Plugin to be installed.

The Headless WP Plugin will append data-wp-block-name and data-wp-block to every block, +the underlying parser used by BlocksRenderer.

Usage

import { isAnchorTag } from '@headstartwp/core';
import { LinkBlock } from '@10up/headless-next';

<BlocksRenderer html={html}>
<LinkBlock test={(node) => isAnchorTag(node, { isInternalLink: true})} />
</BlocksRenderer>

Parameters

NameTypeDefault valueDescription
nodeDOMNodeundefinedThe node to test
optionsisAnchorTagOptions{}Supported options
siteundefined | HeadlessConfigundefined

Returns

node is Element

Whether it's an anchor tag according to the options passed

Defined in

packages/core/src/dom/index.ts:77


isBlock

isBlock(node, _options): boolean

Tests a node by tagName and/or className

This function expects to be used with DOMNode objects from html-react-parser, which is +the underlying parser used by BlocksRenderer.

Usage

import { isBlock } from '@headstartwp/core';

<BlocksRenderer html={html}>
<MyCustomBlock
test={(node) => isBlock(node, { tagName: 'div', classList: ['block-class-name'] })}
/>
</BlocksRenderer>

Parameters

NameTypeDescription
nodeDOMNodeThe node to test
_optionsisBlockOptions

Returns

boolean

true if the node passes the test

Defined in

packages/core/src/dom/index.ts:278


isBlockByName

isBlockByName(node, name): boolean

Tests a node by block name. This requires the Headless WP Plugin to be installed.

The Headless WP Plugin will append data-wp-block-name and data-wp-block to every block, this function relies on those attributes to determine if the node is a block.

This function expects to be used with DOMNode objects from html-react-parser, which is -the underlying parser used by BlocksRenderer.

Usage

import { isBlockByName } from '@headstartwp/core';

<BlocksRenderer html={html}>
<MyCustomBlock
test={(node) => isBlock(node, 'core/paragraph')}
/>
</BlocksRenderer>

Parameters

NameTypeDescription
nodeDOMNodeThe node to test
namestringThe block name

Returns

boolean

true if the node passes the test

Defined in

packages/core/src/dom/index.ts:334


isImageTag

isImageTag(node, options?): string | boolean

Checks if the provided node is an valid image tag

This function expects to be used with DOMNode objects from html-react-parser, which is -the underlying parser used by BlocksRenderer.

Usage

import { isImageTag, ImageBlock } from '@headstartwp/core';
import { ImageComponent } from '@10up/headless-next';

<BlocksRenderer html={html}>
<ImageBlock
test={(node) => isImageTag(node, { hasDimensions: true})}
component={ImageComponent}
/>
</BlocksRenderer>

Parameters

NameTypeDescription
nodeDOMNodeThe node to test
optionsisImageTagOptionsSupported options.

Returns

string | boolean

Whether it's an image tag or not according to the options passed

Defined in

packages/core/src/dom/index.ts:141


isTwitterEmbed

isTwitterEmbed(node): boolean

Checks if the node is an twitter embed

This function expects to be used with DOMNode objects from html-react-parser, which is -the underlying parser used by BlocksRenderer.

Usage

import { isTwitterEmbed } from '@headstartwp/core';

<BlocksRenderer html={html}>
<MyTwitterBlock
test={isTwitterEmbed}
/>
</BlocksRenderer>

Parameters

NameTypeDescription
nodeDOMNodeThe node to test

Returns

boolean

true if the node is a twitter embed

Defined in

packages/core/src/dom/index.ts:227


isYoutubeEmbed

isYoutubeEmbed(node): boolean

Checks if the node is an youtube embed

This function expects to be used with DOMNode objects from html-react-parser, which is -the underlying parser used by BlocksRenderer.

Usage

import { isYoutubeEmbed } from '@headstartwp/core';

<BlocksRenderer html={html}>
<MyYoutubeBlock
test={isYoutubeEmbed}
/>
</BlocksRenderer>

Parameters

NameTypeDescription
nodeDOMNodeThe node to test

Returns

boolean

true if the node is a youtube embed

Defined in

packages/core/src/dom/index.ts:187


wpKsesPost

wpKsesPost(content, allowList?, options?): string

Sanitize HTML content by the wp_kses_post() requirements

Usage

import { wpKsesPost } from '@headstartwp/core';
wpKsesPost(html);

See

https://codex.wordpress.org/Function_Reference/wp_kses_post

Parameters

NameTypeDescription
contentstringThe content to sanitize.
allowList?IWhiteListOptional. The list of allowed HTML tags and attributes. If not set, the default allow list will be used.
options?IWpKsesPostOptionsOptional. IWpKsesPostOptions.

Returns

string

Sanitized string of HTML.

Defined in

packages/core/src/dom/wpKsesPost.ts:30

Data Fetching

apiGet

apiGet(url, args?, burstCache?): Promise<{ headers: { [index: string]: any; } = receivedHeaders; json: any }>

Fetch Wrapper to handle GET requests.

Parameters

NameTypeDefault valueDescription
urlstringundefinedThe URL where to make the request to
argsObject{}The arguments
burstCachebooleanfalseWhether it should burst cache

Returns

Promise<{ headers: { [index: string]: any; } = receivedHeaders; json: any }>

Defined in

packages/core/src/data/api/fetch-utils.ts:46


apiPost

apiPost(url, args?): Promise<any>

Fetch Wrapper to handle POST requests

Parameters

NameTypeDescription
urlstringThe URL where to make the request to
argsObjectThe arguments

Returns

Promise<any>

Defined in

packages/core/src/data/api/fetch-utils.ts:17

Data Handling

getPostAuthor

getPostAuthor(post): AuthorEntity[]

Returns the author object from the post object if it exists

Parameters

NameTypeDescription
postPostEntityThe Post object

Returns

AuthorEntity[]

Defined in

packages/core/src/data/utils/postHandling.ts:11


getPostTerms

getPostTerms(post): Record<string, TermEntity[]>

Returns the terms associated with the post

Parameters

NameTypeDescription
postPostEntityThe Post object

Returns

Record<string, TermEntity[]>

Defined in

packages/core/src/data/utils/postHandling.ts:22

Other

CustomPostType

Ƭ CustomPostType: Object

Type declaration

NameTypeDescription
archive?string-
endpointstring-
matchSinglePath?booleanWhether this custom post type should match the archive path If set to true, then when querying a post type archive page such as /[post-type]/[post-name] the post.link property should match the current path. This will avoid matching nested posts/pages that doesn't exist for instance: /[post-type]/fake-parent-page/[post-name] will not match if this option is set to true even though post-name exists. It is strongly recommended to set this option to true, otherwise hierarchical post types (such as pages) will not work properly. Default true
single?string-
slugstring-

Defined in

packages/core/src/types.ts:1


CustomPostTypes

Ƭ CustomPostTypes: CustomPostType[]

Defined in

packages/core/src/types.ts:21


CustomTaxonomies

Ƭ CustomTaxonomies: CustomTaxonomy[]

Defined in

packages/core/src/types.ts:43


CustomTaxonomy

Ƭ CustomTaxonomy: Object

Type declaration

NameTypeDescription
endpointstring-
matchArchivePath?booleanWhether this custom taxonomy should match the archive path If set to true, then when querying a taxonomy archive page such as /[taxonmy-slug]/[term-slug] the term.link property should match the current path. This will avoid matching nested categories that doesn't exist for instance: /[taxonmy-slug]/fake-parent-term/[term-slug] will not match if this option is set to true even though term-slug exists. Default false
restParam?string-
rewrite?string-
slugstring-

Defined in

packages/core/src/types.ts:25


DOMNode

Ƭ DOMNode: Comment | Element | Node | ProcessingInstruction | Text

Defined in

node_modules/html-react-parser/index.d.ts:21


HTMLParser2Options

Ƭ HTMLParser2Options: ParserOptions & DomHandlerOptions

Defined in

node_modules/html-react-parser/index.d.ts:19


HeadlessConfig

Ƭ HeadlessConfig: Object

Type declaration

NameType
customPostTypes?CustomPostTypes | (defaultPostTypes: CustomPostTypes) => CustomPostTypes
customTaxonomies?CustomTaxonomies | (defaultTaxonomies: CustomTaxonomies) => CustomTaxonomies
debug?{ devMode?: boolean ; redirects?: boolean ; requests?: boolean }
debug.devMode?boolean
debug.redirects?boolean
debug.requests?boolean
host?string
hostUrl?string
integrations?Integrations
locale?string
redirectStrategy?RedirectStrategy
sites?HeadlessConfig[]
sourceUrl?string
useWordPressPlugin?boolean

Defined in

packages/core/src/types.ts:58


Integrations

Ƭ Integrations: Object

Type declaration

NameType
polylang?PolylangIntegration
yoastSEO?YoastSEOIntegration

Defined in

packages/core/src/types.ts:53


Matcher

Ƭ Matcher: Object

Type declaration

NameType
namestring
patternstring
prioritynumber

Defined in

packages/core/src/data/utils/matchers.ts:1


NormalizedDataForCache

Ƭ NormalizedDataForCache<T, P>: Object

Type parameters

Name
T
P

Type declaration

NameType
additionalCacheObjects?NormalizedDataForCache<T, P>[]
dataFetchResponse<T>
key{ args: Partial<P> ; url: string }
key.argsPartial<P>
key.urlstring

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:83


PostOrPostsFetchStrategyResult

Ƭ PostOrPostsFetchStrategyResult<T>: Object

Type parameters

Name
T

Type declaration

NameType
dataT | T[]
isArchiveboolean
isSingleboolean

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:42


QueriedObject

Ƭ QueriedObject: Object

The QueriedObject represents the object that the current requests is subjected to.

Querying by taxonomy and/or author will set the queried object.

Type declaration

NameTypeDescription
author?AuthorEntityIf the request is an author query, this will be populated with the author object
search?SearchEntityIf the request is a search query, this will be populated with the search entity object
term?TermEntityIf the request is a term query, this will be populated with the term object

Defined in

packages/core/src/data/types/entities.ts:707


Redirect

Ƭ Redirect: Object

Type declaration

NameType
IDnumber
enable_regexboolean
post_statusstring
redirect_fromstring
redirect_tostring
status_codenumber

Defined in

packages/core/src/data/types/entities.ts:647


RedirectData

Ƭ RedirectData: Object

Type declaration

NameTypeDescription
locationstring | undefined | nullThe redirect new location will be null if no redirect is found
statusnumberThe status number of the redirect Will be 0 if the redirect is not found

Defined in

packages/core/src/utils/fetchRedirect.ts:5


RedirectStrategy

Ƭ RedirectStrategy: "404" | "none" | "always"

Defined in

packages/core/src/types.ts:23


isAnchorTagOptions

Ƭ isAnchorTagOptions: Object

Type declaration

NameTypeDescription
isInternalLink?booleanIf true, will check if the anchor tag contains a valid internal link. if target="_blank" then this option is not taken into account

Defined in

packages/core/src/dom/index.ts:5


isBlockOptions

Ƭ isBlockOptions: Object

Type declaration

NameTypeDescription
className?string | string[]A single or array of classNames to check for If an array of class names is passed, the block will be considered valid if all of the class names are found
tagName?stringThe tagName to check for

Defined in

packages/core/src/dom/index.ts:238


isImageTagOptions

Ƭ isImageTagOptions: Object

Type declaration

NameTypeDescription
hasDimensions?booleanIf true, will check if the image tag contains width and height attributes

Defined in

packages/core/src/dom/index.ts:107


removeSourceUrlType

Ƭ removeSourceUrlType: Object

Type declaration

NameTypeDescription
backendUrlstringThe backend url.
linkstringThe link url, possibly with the source url.
publicUrl?stringThe public url. Defaults to '/'.

Defined in

packages/core/src/utils/removeSourceUrl.ts:3


authorArchivesMatchers

Const authorArchivesMatchers: Matcher[]

Defined in

packages/core/src/data/utils/matchers.ts:43


endpoints

Const endpoints: Object

Type declaration

NameType
appSettingsstring
categorystring
pagesstring
postsstring
tagsstring
tokenVerifystring
yoaststring

Defined in

packages/core/src/utils/endpoints.ts:1


ksesAllowedList

Const ksesAllowedList: IWhiteList

Default Allowed HTML Attributes

See

https://codex.wordpress.org/Function_Reference/wp_kses_post

Defined in

packages/core/src/dom/wpKsesPost.ts:266


postMatchers

Const postMatchers: Matcher[]

Defined in

packages/core/src/data/utils/matchers.ts:7


postsMatchers

Const postsMatchers: Matcher[]

Defined in

packages/core/src/data/utils/matchers.ts:20


searchMatchers

Const searchMatchers: Matcher[]

Defined in

packages/core/src/data/utils/matchers.ts:56


youtubeEmbedRegex

Const youtubeEmbedRegex: RegExp

Defined in

packages/core/src/dom/index.ts:160


HTMLReactParser

HTMLReactParser(html, options?): ReturnType<typeof domToReact>

Converts HTML string to JSX element(s).

Parameters

NameTypeDescription
htmlstringHTML string.
options?HTMLReactParserOptionsParser options.

Returns

ReturnType<typeof domToReact>

  • JSX element(s), empty array, or string.

Defined in

node_modules/html-react-parser/index.d.ts:51


addQueryArgs

addQueryArgs(url, args): string

Parameters

NameType
urlstring
argsRecord<string, any>

Returns

string

Defined in

packages/core/src/utils/url.ts:167


asyncForEach

asyncForEach(array, callback): Promise<void>

Parameters

NameType
arrayany[]
callback(el: any, index: number, array: any[]) => void

Returns

Promise<void>

Defined in

packages/core/src/utils/asyncForEach.ts:1


attributesToProps

attributesToProps(attributes, nodeName?): Props

Converts HTML/SVG DOM attributes to React props.

Parameters

NameTypeDescription
attributesAttributesHTML/SVG DOM attributes.
nodeName?stringDOM node name.

Returns

Props

  • React props.

Defined in

node_modules/html-react-parser/lib/attributes-to-props.d.ts:17


buildQueryString

buildQueryString(data): string

Generates URL-encoded query string using input query data.

It is intended to behave equivalent as PHP's http_build_query, configured -with encoding type PHP_QUERY_RFC3986 (spaces as %20).

Example

const queryString = buildQueryString( {
simple: 'is ok',
arrays: [ 'are', 'fine', 'too' ],
objects: {
evenNested: {
ok: 'yes',
},
},
} );
// "simple=is%20ok&arrays%5B0%5D=are&arrays%5B1%5D=fine&arrays%5B2%5D=too&objects%5BevenNested%5D%5Bok%5D=yes"

Parameters

NameTypeDescription
dataRecord<string, any>Data to encode.

Returns

string

Query string.

Defined in

packages/core/src/utils/url.ts:129


decodeHtmlSpeciaChars

decodeHtmlSpeciaChars(text): string

Decodes HTML special chars entities

Parameters

NameTypeDescription
textstringThe text we want to decode

Returns

string

text with decoded html entities

Defined in

packages/core/src/utils/decodeHtmlSpeciaChars.ts:8


domToReact

domToReact(nodes, options?): string | JSX.Element | JSX.Element[]

Converts DOM nodes to JSX element(s).

Parameters

NameTypeDescription
nodesDOMNode[]DOM nodes.
options?HTMLReactParserOptionsParser options.

Returns

string | JSX.Element | JSX.Element[]

  • JSX element(s).

Defined in

node_modules/html-react-parser/lib/dom-to-react.d.ts:15


fetchRedirect

fetchRedirect(pathname, sourceUrl): Promise<RedirectData>

Fetches a redirect from the WordPress origin by making a HEAD request and checking the response

Parameters

NameTypeDescription
pathnamestringThe path to the page to fetch the redirect for
sourceUrlstringThe source url

Returns

Promise<RedirectData>

The redirect data

Defined in

packages/core/src/utils/fetchRedirect.ts:51


getAuthHeader

getAuthHeader(): null

Returns

null

Defined in

packages/core/src/data/api/fetch-utils.ts:3


getCustomPostType

getCustomPostType(slug, sourceUrl?): undefined | CustomPostType

Returns a single post type by slug if defined

Parameters

NameTypeDescription
slugstringpost type slug
sourceUrl?string

Returns

undefined | CustomPostType

Defined in

packages/core/src/utils/config.ts:248


getCustomPostTypes

getCustomPostTypes(sourceUrl?): CustomPostTypes

Returns the available post types

Parameters

NameType
sourceUrl?string

Returns

CustomPostTypes

Defined in

packages/core/src/utils/config.ts:225


getCustomPostTypesSlugs

getCustomPostTypesSlugs(sourceUrl?): string[]

Returns the available post type slugs

Parameters

NameType
sourceUrl?string

Returns

string[]

Defined in

packages/core/src/utils/config.ts:236


getCustomTaxonomies

getCustomTaxonomies(sourceUrl?): CustomTaxonomies

Returns the available taxonomies

Parameters

NameType
sourceUrl?string

Returns

CustomTaxonomies

Defined in

packages/core/src/utils/config.ts:185


getCustomTaxonomy

getCustomTaxonomy(slug, sourceUrl?): undefined | CustomTaxonomy

Returns a single post type by slug if defined

Parameters

NameTypeDescription
slugstringpost type slug
sourceUrl?string

Returns

undefined | CustomTaxonomy

Defined in

packages/core/src/utils/config.ts:214


getCustomTaxonomySlugs

getCustomTaxonomySlugs(sourceUrl?): string[]

Returns the available taxonomy slugs

Parameters

NameType
sourceUrl?string

Returns

string[]

Defined in

packages/core/src/utils/config.ts:197


getHeadlessConfig

getHeadlessConfig(): Object

Returns the contents of headless.config.js

This function requires framework integration in order to work. The contents of headless.config.js -needs to be injected at build time into a global variable.

Make sure you are using one of the framework's integration (such as next) before using this function.

Returns

Object

The contents of headless.config.js

NameType
customPostTypesCustomPostTypes
customTaxonomiesCustomTaxonomies
debugundefined | { devMode?: boolean ; redirects?: boolean ; requests?: boolean }
hostUrlstring
integrationsundefined | Integrations
redirectStrategyRedirectStrategy
sitesHeadlessConfig[]
sourceUrlundefined | string
useWordPressPluginboolean

Defined in

packages/core/src/utils/config.ts:22


getHeadstartWPConfig

getHeadstartWPConfig(): Object

Returns the contents of headless.config.js

This function requires framework integration in order to work. The contents of headless.config.js -needs to be injected at build time into a global variable.

Make sure you are using one of the framework's integration (such as next) before using this function.

Returns

Object

The contents of headless.config.js

NameType
customPostTypesCustomPostTypes
customTaxonomiesCustomTaxonomies
debugundefined | { devMode?: boolean ; redirects?: boolean ; requests?: boolean }
hostUrlstring
integrationsundefined | Integrations
redirectStrategyRedirectStrategy
sitesHeadlessConfig[]
sourceUrlundefined | string
useWordPressPluginboolean

Defined in

packages/core/src/utils/config.ts:22


getHostUrl

getHostUrl(): string

Returns the WP URL based on the headless config

Returns

string

Defined in

packages/core/src/utils/config.ts:265


getQueryArgs

getQueryArgs(url): Record<string, any>

Returns an object of query arguments of the given URL. If the given URL is -invalid or has no querystring, an empty object is returned.

Example

const foo = getQueryArgs( 'https://wordpress.org?foo=bar&bar=baz' );
// { "foo": "bar", "bar": "baz" }

Parameters

NameTypeDescription
urlstringURL.

Returns

Record<string, any>

Query args object.

Defined in

packages/core/src/utils/url.ts:78


getQueryString

getQueryString(url): any

Parameters

NameType
urlstring

Returns

any

Defined in

packages/core/src/utils/url.ts:49


getSite

getSite(site?): HeadlessConfig

Get a config for a specific site

Parameters

NameType
site?HeadlessConfig

Returns

HeadlessConfig

Defined in

packages/core/src/utils/config.ts:111


getSiteByHost

getSiteByHost(hostOrUrl, locale?): null | HeadlessConfig

Finds a site by host and optionally locale

Parameters

NameTypeDescription
hostOrUrlstringThe hostname
locale?string

Returns

null | HeadlessConfig

Defined in

packages/core/src/utils/config.ts:135


getSiteBySourceUrl

getSiteBySourceUrl(sourceUrl): HeadlessConfig

Get a site by source url

Parameters

NameType
sourceUrlstring

Returns

HeadlessConfig

HeadlessConfig

Defined in

packages/core/src/utils/config.ts:173


getWPUrl

getWPUrl(): string

Returns the WP URL based on the headless config

Returns

string

Defined in

packages/core/src/utils/config.ts:257


htmlToDOM

htmlToDOM(html, options?): (Comment | Element | ProcessingInstruction | Text)[]

Parses HTML string to DOM nodes in Node.js.

This is the same method as require('htmlparser2').parseDOM -https://github.com/fb55/htmlparser2/blob/v6.0.0/src/index.ts#L29-L41

Parameters

NameTypeDescription
htmlstringHTML markup.
options?DomHandlerOptionsParser options (https://github.com/fb55/domhandler/tree/v5.0.3#readme).

Returns

(Comment | Element | ProcessingInstruction | Text)[]

  • DOM nodes.

Defined in

node_modules/html-dom-parser/lib/server/html-to-dom.d.ts:21


isElement

isElement(node): node is Element

Checks if the node is an Element.

We rely on this function to avoid issues with instanceof.

See

https://github.com/10up/headstartwp/issues/504

Parameters

NameTypeDescription
nodeDOMNodeThe dom node

Returns

node is Element

Whether the node is of type element or not

Defined in

packages/core/src/dom/index.ts:25


isExternalUrl

isExternalUrl(link): boolean

Checks if the provided link is an external Url.

Inspired on the Frontity implementation

See

https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts

Parameters

NameTypeDescription
linkstringThe link Url.

Returns

boolean

True if the link is an external Url.

Defined in

packages/core/src/utils/isExternalUrl.ts:12


isInternalLink(url, site?): boolean

Checks if the url is for an internal link

Parameters

NameTypeDescription
urlstringThe url to check
site?HeadlessConfig(optional) the site config

Returns

boolean

Defined in

packages/core/src/utils/isInternalLink.ts:14


log

log(type, ...args): void

Parameters

NameType
typeLOGTYPE
...argsany[]

Returns

void

Defined in

packages/core/src/utils/log.ts:9


removeFieldsFromPostRelatedData

removeFieldsFromPostRelatedData(fieldsToRemove, post): PostEntity | { _embedded: { author: AuthorEntity[] ; wp:featuredmedia: any ; wp:term: TermEntity[][] } ; author?: AuthorEntity[] ; categories?: number[] ; comment_status?: "open" | "closed" ; content: Rendered ; date: string ; date_gmt: string ; excerpt: Rendered ; featured_media: number ; format: "link" | "status" | "standard" | "aside" | "chat" | "gallery" | "image" | "quote" | "video" | "audio" ; guid: Rendered ; id: number ; link: string ; meta: Record<string, unknown> ; modified: string ; modified_gmt: string ; ping_status: "open" | "closed" ; slug: string ; status: "publish" | "future" | "draft" | "pending" | "private" ; sticky: boolean ; tags?: number[] ; template: string ; terms?: Record<string, TermEntity[]> ; title: Rendered ; type: string ; yoast_head?: null | string ; yoast_head_json?: null | Record<string, any> }

Parameters

NameType
fieldsToRemove(string | number)[]
postPostEntity

Returns

PostEntity | { _embedded: { author: AuthorEntity[] ; wp:featuredmedia: any ; wp:term: TermEntity[][] } ; author?: AuthorEntity[] ; categories?: number[] ; comment_status?: "open" | "closed" ; content: Rendered ; date: string ; date_gmt: string ; excerpt: Rendered ; featured_media: number ; format: "link" | "status" | "standard" | "aside" | "chat" | "gallery" | "image" | "quote" | "video" | "audio" ; guid: Rendered ; id: number ; link: string ; meta: Record<string, unknown> ; modified: string ; modified_gmt: string ; ping_status: "open" | "closed" ; slug: string ; status: "publish" | "future" | "draft" | "pending" | "private" ; sticky: boolean ; tags?: number[] ; template: string ; terms?: Record<string, TermEntity[]> ; title: Rendered ; type: string ; yoast_head?: null | string ; yoast_head_json?: null | Record<string, any> }

Defined in

packages/core/src/data/utils/postHandling.ts:47


removeSourceUrl

removeSourceUrl(«destructured»): string

Make the link relative if it belongs to the backend, to force client-side -navigation.

Inspired on the Frontity implementation

See

https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts

Parameters

NameType
«destructured»removeSourceUrlType

Returns

string

The URL without the Source URL.

Defined in

packages/core/src/utils/removeSourceUrl.ts:30


setHeadlessConfig

setHeadlessConfig(config): void

Parameters

NameType
configHeadlessConfig

Returns

void

Defined in

packages/core/src/utils/config.ts:6


setHeadstartWPConfig

setHeadstartWPConfig(config): void

Parameters

NameType
configHeadlessConfig

Returns

void

Defined in

packages/core/src/utils/config.ts:6


stripTags

stripTags(html): any

Utility functions to strip any tags

Parameters

NameTypeDescription
htmlanyThe html string

Returns

any

Defined in

packages/core/src/dom/stripTags.ts:8


warn

warn(message): void

Logs a warning in the console in dev mode

Example

warn("You should do/change something.")

Parameters

NameTypeDescription
messagestringThe message that describes the warning.

Returns

void

Defined in

packages/core/src/utils/errors.ts:45

Utility Functions

parsePath

parsePath(matchers, path): Record<string, string>

Parses a path and extracts the parameters from it

Parameters

NameTypeDescription
matchersMatcher[]An array of Matchers
pathstringThe path

Returns

Record<string, string>

the extracted parameters

Defined in

packages/core/src/data/utils/parsePath.ts:46

- +the underlying parser used by BlocksRenderer.

Usage

import { isBlockByName } from '@headstartwp/core';

<BlocksRenderer html={html}>
<MyCustomBlock
test={(node) => isBlock(node, 'core/paragraph')}
/>
</BlocksRenderer>

Parameters

NameTypeDescription
nodeDOMNodeThe node to test
namestringThe block name

Returns

boolean

true if the node passes the test

Defined in

packages/core/src/dom/index.ts:334


isImageTag

isImageTag(node, options?): string | boolean

Checks if the provided node is an valid image tag

This function expects to be used with DOMNode objects from html-react-parser, which is +the underlying parser used by BlocksRenderer.

Usage

import { isImageTag, ImageBlock } from '@headstartwp/core';
import { ImageComponent } from '@10up/headless-next';

<BlocksRenderer html={html}>
<ImageBlock
test={(node) => isImageTag(node, { hasDimensions: true})}
component={ImageComponent}
/>
</BlocksRenderer>

Parameters

NameTypeDescription
nodeDOMNodeThe node to test
optionsisImageTagOptionsSupported options.

Returns

string | boolean

Whether it's an image tag or not according to the options passed

Defined in

packages/core/src/dom/index.ts:141


isTwitterEmbed

isTwitterEmbed(node): boolean

Checks if the node is an twitter embed

This function expects to be used with DOMNode objects from html-react-parser, which is +the underlying parser used by BlocksRenderer.

Usage

import { isTwitterEmbed } from '@headstartwp/core';

<BlocksRenderer html={html}>
<MyTwitterBlock
test={isTwitterEmbed}
/>
</BlocksRenderer>

Parameters

NameTypeDescription
nodeDOMNodeThe node to test

Returns

boolean

true if the node is a twitter embed

Defined in

packages/core/src/dom/index.ts:227


isYoutubeEmbed

isYoutubeEmbed(node): boolean

Checks if the node is an youtube embed

This function expects to be used with DOMNode objects from html-react-parser, which is +the underlying parser used by BlocksRenderer.

Usage

import { isYoutubeEmbed } from '@headstartwp/core';

<BlocksRenderer html={html}>
<MyYoutubeBlock
test={isYoutubeEmbed}
/>
</BlocksRenderer>

Parameters

NameTypeDescription
nodeDOMNodeThe node to test

Returns

boolean

true if the node is a youtube embed

Defined in

packages/core/src/dom/index.ts:187


wpKsesPost

wpKsesPost(content, allowList?, options?): string

Sanitize HTML content by the wp_kses_post() requirements

Usage

import { wpKsesPost } from '@headstartwp/core';
wpKsesPost(html);

See

https://codex.wordpress.org/Function_Reference/wp_kses_post

Parameters

NameTypeDescription
contentstringThe content to sanitize.
allowList?IWhiteListOptional. The list of allowed HTML tags and attributes. If not set, the default allow list will be used.
options?IWpKsesPostOptionsOptional. IWpKsesPostOptions.

Returns

string

Sanitized string of HTML.

Defined in

packages/core/src/dom/wpKsesPost.ts:30

Data Fetching

apiGet

apiGet(url, args?, burstCache?): Promise<{ headers: { [index: string]: any; } = receivedHeaders; json: any }>

Fetch Wrapper to handle GET requests.

Parameters

NameTypeDefault valueDescription
urlstringundefinedThe URL where to make the request to
argsObject{}The arguments
burstCachebooleanfalseWhether it should burst cache

Returns

Promise<{ headers: { [index: string]: any; } = receivedHeaders; json: any }>

Defined in

packages/core/src/data/api/fetch-utils.ts:46


apiPost

apiPost(url, args?): Promise<any>

Fetch Wrapper to handle POST requests

Parameters

NameTypeDescription
urlstringThe URL where to make the request to
argsObjectThe arguments

Returns

Promise<any>

Defined in

packages/core/src/data/api/fetch-utils.ts:17

Data Handling

getPostAuthor

getPostAuthor(post): AuthorEntity[]

Returns the author object from the post object if it exists

Parameters

NameTypeDescription
postPostEntityThe Post object

Returns

AuthorEntity[]

Defined in

packages/core/src/data/utils/postHandling.ts:11


getPostTerms

getPostTerms(post): Record<string, TermEntity[]>

Returns the terms associated with the post

Parameters

NameTypeDescription
postPostEntityThe Post object

Returns

Record<string, TermEntity[]>

Defined in

packages/core/src/data/utils/postHandling.ts:22

Other

CustomPostType

Ƭ CustomPostType: Object

Type declaration

NameTypeDescription
archive?string-
endpointstring-
matchSinglePath?booleanWhether this custom post type should match the archive path If set to true, then when querying a post type archive page such as /[post-type]/[post-name] the post.link property should match the current path. This will avoid matching nested posts/pages that doesn't exist for instance: /[post-type]/fake-parent-page/[post-name] will not match if this option is set to true even though post-name exists. It is strongly recommended to set this option to true, otherwise hierarchical post types (such as pages) will not work properly. Default true
single?string-
slugstring-

Defined in

packages/core/src/types.ts:1


CustomPostTypes

Ƭ CustomPostTypes: CustomPostType[]

Defined in

packages/core/src/types.ts:21


CustomTaxonomies

Ƭ CustomTaxonomies: CustomTaxonomy[]

Defined in

packages/core/src/types.ts:43


CustomTaxonomy

Ƭ CustomTaxonomy: Object

Type declaration

NameTypeDescription
endpointstring-
matchArchivePath?booleanWhether this custom taxonomy should match the archive path If set to true, then when querying a taxonomy archive page such as /[taxonmy-slug]/[term-slug] the term.link property should match the current path. This will avoid matching nested categories that doesn't exist for instance: /[taxonmy-slug]/fake-parent-term/[term-slug] will not match if this option is set to true even though term-slug exists. Default false
restParam?string-
rewrite?string-
slugstring-

Defined in

packages/core/src/types.ts:25


DOMNode

Ƭ DOMNode: Comment | Element | Node | ProcessingInstruction | Text

Defined in

node_modules/html-react-parser/index.d.ts:21


HTMLParser2Options

Ƭ HTMLParser2Options: ParserOptions & DomHandlerOptions

Defined in

node_modules/html-react-parser/index.d.ts:19


HeadlessConfig

Ƭ HeadlessConfig: Object

Type declaration

NameType
customPostTypes?CustomPostTypes | (defaultPostTypes: CustomPostTypes) => CustomPostTypes
customTaxonomies?CustomTaxonomies | (defaultTaxonomies: CustomTaxonomies) => CustomTaxonomies
debug?{ devMode?: boolean ; redirects?: boolean ; requests?: boolean }
debug.devMode?boolean
debug.redirects?boolean
debug.requests?boolean
host?string
hostUrl?string
integrations?Integrations
locale?string
redirectStrategy?RedirectStrategy
sites?HeadlessConfig[]
sourceUrl?string
useWordPressPlugin?boolean

Defined in

packages/core/src/types.ts:58


Integrations

Ƭ Integrations: Object

Type declaration

NameType
polylang?PolylangIntegration
yoastSEO?YoastSEOIntegration

Defined in

packages/core/src/types.ts:53


Matcher

Ƭ Matcher: Object

Type declaration

NameType
namestring
patternstring
prioritynumber

Defined in

packages/core/src/data/utils/matchers.ts:1


NormalizedDataForCache

Ƭ NormalizedDataForCache<T, P>: Object

Type parameters

Name
T
P

Type declaration

NameType
additionalCacheObjects?NormalizedDataForCache<T, P>[]
dataFetchResponse<T>
key{ args: Partial<P> ; url: string }
key.argsPartial<P>
key.urlstring

Defined in

packages/core/src/data/strategies/AbstractFetchStrategy.ts:83


PostOrPostsFetchStrategyResult

Ƭ PostOrPostsFetchStrategyResult<T>: Object

Type parameters

Name
T

Type declaration

NameType
dataT | T[]
isArchiveboolean
isSingleboolean

Defined in

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:42


QueriedObject

Ƭ QueriedObject: Object

The QueriedObject represents the object that the current requests is subjected to.

Querying by taxonomy and/or author will set the queried object.

Type declaration

NameTypeDescription
author?AuthorEntityIf the request is an author query, this will be populated with the author object
search?SearchEntityIf the request is a search query, this will be populated with the search entity object
term?TermEntityIf the request is a term query, this will be populated with the term object

Defined in

packages/core/src/data/types/entities.ts:707


Redirect

Ƭ Redirect: Object

Type declaration

NameType
IDnumber
enable_regexboolean
post_statusstring
redirect_fromstring
redirect_tostring
status_codenumber

Defined in

packages/core/src/data/types/entities.ts:647


RedirectData

Ƭ RedirectData: Object

Type declaration

NameTypeDescription
locationstring | undefined | nullThe redirect new location will be null if no redirect is found
statusnumberThe status number of the redirect Will be 0 if the redirect is not found

Defined in

packages/core/src/utils/fetchRedirect.ts:5


RedirectStrategy

Ƭ RedirectStrategy: "404" | "none" | "always"

Defined in

packages/core/src/types.ts:23


isAnchorTagOptions

Ƭ isAnchorTagOptions: Object

Type declaration

NameTypeDescription
isInternalLink?booleanIf true, will check if the anchor tag contains a valid internal link. if target="_blank" then this option is not taken into account

Defined in

packages/core/src/dom/index.ts:5


isBlockOptions

Ƭ isBlockOptions: Object

Type declaration

NameTypeDescription
className?string | string[]A single or array of classNames to check for If an array of class names is passed, the block will be considered valid if all of the class names are found
tagName?stringThe tagName to check for

Defined in

packages/core/src/dom/index.ts:238


isImageTagOptions

Ƭ isImageTagOptions: Object

Type declaration

NameTypeDescription
hasDimensions?booleanIf true, will check if the image tag contains width and height attributes

Defined in

packages/core/src/dom/index.ts:107


removeSourceUrlType

Ƭ removeSourceUrlType: Object

Type declaration

NameTypeDescription
backendUrlstringThe backend url.
linkstringThe link url, possibly with the source url.
publicUrl?stringThe public url. Defaults to '/'.

Defined in

packages/core/src/utils/removeSourceUrl.ts:3


authorArchivesMatchers

Const authorArchivesMatchers: Matcher[]

Defined in

packages/core/src/data/utils/matchers.ts:43


endpoints

Const endpoints: Object

Type declaration

NameType
appSettingsstring
categorystring
pagesstring
postsstring
tagsstring
tokenVerifystring
yoaststring

Defined in

packages/core/src/utils/endpoints.ts:1


ksesAllowedList

Const ksesAllowedList: IWhiteList

Default Allowed HTML Attributes

See

https://codex.wordpress.org/Function_Reference/wp_kses_post

Defined in

packages/core/src/dom/wpKsesPost.ts:266


postMatchers

Const postMatchers: Matcher[]

Defined in

packages/core/src/data/utils/matchers.ts:7


postsMatchers

Const postsMatchers: Matcher[]

Defined in

packages/core/src/data/utils/matchers.ts:20


searchMatchers

Const searchMatchers: Matcher[]

Defined in

packages/core/src/data/utils/matchers.ts:56


youtubeEmbedRegex

Const youtubeEmbedRegex: RegExp

Defined in

packages/core/src/dom/index.ts:160


HTMLReactParser

HTMLReactParser(html, options?): ReturnType<typeof domToReact>

Converts HTML string to JSX element(s).

Parameters

NameTypeDescription
htmlstringHTML string.
options?HTMLReactParserOptionsParser options.

Returns

ReturnType<typeof domToReact>

Defined in

node_modules/html-react-parser/index.d.ts:51


addQueryArgs

addQueryArgs(url, args): string

Parameters

NameType
urlstring
argsRecord<string, any>

Returns

string

Defined in

packages/core/src/utils/url.ts:167


asyncForEach

asyncForEach(array, callback): Promise<void>

Parameters

NameType
arrayany[]
callback(el: any, index: number, array: any[]) => void

Returns

Promise<void>

Defined in

packages/core/src/utils/asyncForEach.ts:1


attributesToProps

attributesToProps(attributes, nodeName?): Props

Converts HTML/SVG DOM attributes to React props.

Parameters

NameTypeDescription
attributesAttributesHTML/SVG DOM attributes.
nodeName?stringDOM node name.

Returns

Props

Defined in

node_modules/html-react-parser/lib/attributes-to-props.d.ts:17


buildQueryString

buildQueryString(data): string

Generates URL-encoded query string using input query data.

It is intended to behave equivalent as PHP's http_build_query, configured +with encoding type PHP_QUERY_RFC3986 (spaces as %20).

Example

const queryString = buildQueryString( {
simple: 'is ok',
arrays: [ 'are', 'fine', 'too' ],
objects: {
evenNested: {
ok: 'yes',
},
},
} );
// "simple=is%20ok&arrays%5B0%5D=are&arrays%5B1%5D=fine&arrays%5B2%5D=too&objects%5BevenNested%5D%5Bok%5D=yes"

Parameters

NameTypeDescription
dataRecord<string, any>Data to encode.

Returns

string

Query string.

Defined in

packages/core/src/utils/url.ts:129


decodeHtmlSpeciaChars

decodeHtmlSpeciaChars(text): string

Decodes HTML special chars entities

Parameters

NameTypeDescription
textstringThe text we want to decode

Returns

string

text with decoded html entities

Defined in

packages/core/src/utils/decodeHtmlSpeciaChars.ts:8


domToReact

domToReact(nodes, options?): string | JSX.Element | JSX.Element[]

Converts DOM nodes to JSX element(s).

Parameters

NameTypeDescription
nodesDOMNode[]DOM nodes.
options?HTMLReactParserOptionsParser options.

Returns

string | JSX.Element | JSX.Element[]

Defined in

node_modules/html-react-parser/lib/dom-to-react.d.ts:15


fetchRedirect

fetchRedirect(pathname, sourceUrl): Promise<RedirectData>

Fetches a redirect from the WordPress origin by making a HEAD request and checking the response

Parameters

NameTypeDescription
pathnamestringThe path to the page to fetch the redirect for
sourceUrlstringThe source url

Returns

Promise<RedirectData>

The redirect data

Defined in

packages/core/src/utils/fetchRedirect.ts:51


getAuthHeader

getAuthHeader(): null

Returns

null

Defined in

packages/core/src/data/api/fetch-utils.ts:3


getCustomPostType

getCustomPostType(slug, sourceUrl?): undefined | CustomPostType

Returns a single post type by slug if defined

Parameters

NameTypeDescription
slugstringpost type slug
sourceUrl?string

Returns

undefined | CustomPostType

Defined in

packages/core/src/utils/config.ts:248


getCustomPostTypes

getCustomPostTypes(sourceUrl?): CustomPostTypes

Returns the available post types

Parameters

NameType
sourceUrl?string

Returns

CustomPostTypes

Defined in

packages/core/src/utils/config.ts:225


getCustomPostTypesSlugs

getCustomPostTypesSlugs(sourceUrl?): string[]

Returns the available post type slugs

Parameters

NameType
sourceUrl?string

Returns

string[]

Defined in

packages/core/src/utils/config.ts:236


getCustomTaxonomies

getCustomTaxonomies(sourceUrl?): CustomTaxonomies

Returns the available taxonomies

Parameters

NameType
sourceUrl?string

Returns

CustomTaxonomies

Defined in

packages/core/src/utils/config.ts:185


getCustomTaxonomy

getCustomTaxonomy(slug, sourceUrl?): undefined | CustomTaxonomy

Returns a single post type by slug if defined

Parameters

NameTypeDescription
slugstringpost type slug
sourceUrl?string

Returns

undefined | CustomTaxonomy

Defined in

packages/core/src/utils/config.ts:214


getCustomTaxonomySlugs

getCustomTaxonomySlugs(sourceUrl?): string[]

Returns the available taxonomy slugs

Parameters

NameType
sourceUrl?string

Returns

string[]

Defined in

packages/core/src/utils/config.ts:197


getHeadlessConfig

getHeadlessConfig(): Object

Returns the contents of headless.config.js

This function requires framework integration in order to work. The contents of headless.config.js +needs to be injected at build time into a global variable.

Make sure you are using one of the framework's integration (such as next) before using this function.

Returns

Object

The contents of headless.config.js

NameType
customPostTypesCustomPostTypes
customTaxonomiesCustomTaxonomies
debugundefined | { devMode?: boolean ; redirects?: boolean ; requests?: boolean }
hostUrlstring
integrationsundefined | Integrations
redirectStrategyRedirectStrategy
sitesHeadlessConfig[]
sourceUrlundefined | string
useWordPressPluginboolean

Defined in

packages/core/src/utils/config.ts:22


getHeadstartWPConfig

getHeadstartWPConfig(): Object

Returns the contents of headless.config.js

This function requires framework integration in order to work. The contents of headless.config.js +needs to be injected at build time into a global variable.

Make sure you are using one of the framework's integration (such as next) before using this function.

Returns

Object

The contents of headless.config.js

NameType
customPostTypesCustomPostTypes
customTaxonomiesCustomTaxonomies
debugundefined | { devMode?: boolean ; redirects?: boolean ; requests?: boolean }
hostUrlstring
integrationsundefined | Integrations
redirectStrategyRedirectStrategy
sitesHeadlessConfig[]
sourceUrlundefined | string
useWordPressPluginboolean

Defined in

packages/core/src/utils/config.ts:22


getHostUrl

getHostUrl(): string

Returns the WP URL based on the headless config

Returns

string

Defined in

packages/core/src/utils/config.ts:265


getQueryArgs

getQueryArgs(url): Record<string, any>

Returns an object of query arguments of the given URL. If the given URL is +invalid or has no querystring, an empty object is returned.

Example

const foo = getQueryArgs( 'https://wordpress.org?foo=bar&bar=baz' );
// { "foo": "bar", "bar": "baz" }

Parameters

NameTypeDescription
urlstringURL.

Returns

Record<string, any>

Query args object.

Defined in

packages/core/src/utils/url.ts:78


getQueryString

getQueryString(url): any

Parameters

NameType
urlstring

Returns

any

Defined in

packages/core/src/utils/url.ts:49


getSite

getSite(site?): HeadlessConfig

Get a config for a specific site

Parameters

NameType
site?HeadlessConfig

Returns

HeadlessConfig

Defined in

packages/core/src/utils/config.ts:111


getSiteByHost

getSiteByHost(hostOrUrl, locale?): null | HeadlessConfig

Finds a site by host and optionally locale

Parameters

NameTypeDescription
hostOrUrlstringThe hostname
locale?string

Returns

null | HeadlessConfig

Defined in

packages/core/src/utils/config.ts:135


getSiteBySourceUrl

getSiteBySourceUrl(sourceUrl): HeadlessConfig

Get a site by source url

Parameters

NameType
sourceUrlstring

Returns

HeadlessConfig

HeadlessConfig

Defined in

packages/core/src/utils/config.ts:173


getWPUrl

getWPUrl(): string

Returns the WP URL based on the headless config

Returns

string

Defined in

packages/core/src/utils/config.ts:257


htmlToDOM

htmlToDOM(html, options?): (Comment | Element | ProcessingInstruction | Text)[]

Parses HTML string to DOM nodes in Node.js.

This is the same method as require('htmlparser2').parseDOM +https://github.com/fb55/htmlparser2/blob/v6.0.0/src/index.ts#L29-L41

Parameters

NameTypeDescription
htmlstringHTML markup.
options?DomHandlerOptionsParser options (https://github.com/fb55/domhandler/tree/v5.0.3#readme).

Returns

(Comment | Element | ProcessingInstruction | Text)[]

Defined in

node_modules/html-dom-parser/lib/server/html-to-dom.d.ts:21


isElement

isElement(node): node is Element

Checks if the node is an Element.

We rely on this function to avoid issues with instanceof.

See

https://github.com/10up/headstartwp/issues/504

Parameters

NameTypeDescription
nodeDOMNodeThe dom node

Returns

node is Element

Whether the node is of type element or not

Defined in

packages/core/src/dom/index.ts:25


isExternalUrl

isExternalUrl(link): boolean

Checks if the provided link is an external Url.

Inspired on the Frontity implementation

See

https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts

Parameters

NameTypeDescription
linkstringThe link Url.

Returns

boolean

True if the link is an external Url.

Defined in

packages/core/src/utils/isExternalUrl.ts:12


isInternalLink(url, site?): boolean

Checks if the url is for an internal link

Parameters

NameTypeDescription
urlstringThe url to check
site?HeadlessConfig(optional) the site config

Returns

boolean

Defined in

packages/core/src/utils/isInternalLink.ts:14


log

log(type, ...args): void

Parameters

NameType
typeLOGTYPE
...argsany[]

Returns

void

Defined in

packages/core/src/utils/log.ts:9


removeFieldsFromPostRelatedData

removeFieldsFromPostRelatedData(fieldsToRemove, post): PostEntity | { _embedded: { author: AuthorEntity[] ; wp:featuredmedia: any ; wp:term: TermEntity[][] } ; author?: AuthorEntity[] ; categories?: number[] ; comment_status?: "open" | "closed" ; content: Rendered ; date: string ; date_gmt: string ; excerpt: Rendered ; featured_media: number ; format: "link" | "status" | "standard" | "aside" | "chat" | "gallery" | "image" | "quote" | "video" | "audio" ; guid: Rendered ; id: number ; link: string ; meta: Record<string, unknown> ; modified: string ; modified_gmt: string ; ping_status: "open" | "closed" ; slug: string ; status: "publish" | "future" | "draft" | "pending" | "private" ; sticky: boolean ; tags?: number[] ; template: string ; terms?: Record<string, TermEntity[]> ; title: Rendered ; type: string ; yoast_head?: null | string ; yoast_head_json?: null | Record<string, any> }

Parameters

NameType
fieldsToRemove(string | number)[]
postPostEntity

Returns

PostEntity | { _embedded: { author: AuthorEntity[] ; wp:featuredmedia: any ; wp:term: TermEntity[][] } ; author?: AuthorEntity[] ; categories?: number[] ; comment_status?: "open" | "closed" ; content: Rendered ; date: string ; date_gmt: string ; excerpt: Rendered ; featured_media: number ; format: "link" | "status" | "standard" | "aside" | "chat" | "gallery" | "image" | "quote" | "video" | "audio" ; guid: Rendered ; id: number ; link: string ; meta: Record<string, unknown> ; modified: string ; modified_gmt: string ; ping_status: "open" | "closed" ; slug: string ; status: "publish" | "future" | "draft" | "pending" | "private" ; sticky: boolean ; tags?: number[] ; template: string ; terms?: Record<string, TermEntity[]> ; title: Rendered ; type: string ; yoast_head?: null | string ; yoast_head_json?: null | Record<string, any> }

Defined in

packages/core/src/data/utils/postHandling.ts:47


removeSourceUrl

removeSourceUrl(«destructured»): string

Make the link relative if it belongs to the backend, to force client-side +navigation.

Inspired on the Frontity implementation

See

https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts

Parameters

NameType
«destructured»removeSourceUrlType

Returns

string

The URL without the Source URL.

Defined in

packages/core/src/utils/removeSourceUrl.ts:30


setHeadlessConfig

setHeadlessConfig(config): void

Parameters

NameType
configHeadlessConfig

Returns

void

Defined in

packages/core/src/utils/config.ts:6


setHeadstartWPConfig

setHeadstartWPConfig(config): void

Parameters

NameType
configHeadlessConfig

Returns

void

Defined in

packages/core/src/utils/config.ts:6


stripTags

stripTags(html): any

Utility functions to strip any tags

Parameters

NameTypeDescription
htmlanyThe html string

Returns

any

Defined in

packages/core/src/dom/stripTags.ts:8


warn

warn(message): void

Logs a warning in the console in dev mode

Example

warn("You should do/change something.")

Parameters

NameTypeDescription
messagestringThe message that describes the warning.

Returns

void

Defined in

packages/core/src/utils/errors.ts:45

Utility Functions

parsePath

parsePath(matchers, path): Record<string, string>

Parses a path and extracts the parameters from it

Parameters

NameTypeDescription
matchersMatcher[]An array of Matchers
pathstringThe path

Returns

Record<string, string>

the extracted parameters

Defined in

packages/core/src/data/utils/parsePath.ts:46

+ \ No newline at end of file diff --git a/api/modules/headstartwp_next/index.html b/api/modules/headstartwp_next/index.html index eabd07c0c..dc3129f04 100644 --- a/api/modules/headstartwp_next/index.html +++ b/api/modules/headstartwp_next/index.html @@ -7,30 +7,30 @@ - +
-
Skip to main content

Module: @headstartwp/next

Namespaces

Interfaces

API handlers

previewHandler

previewHandler(req, res, options?): Promise<void>

The PreviewHandler is responsible for handling preview requests.

Handling Previews requires the Headless WordPress Plugin.

Important: This function is meant to be used in a api route at /pages/api/preview.

Usage

// pages/api/preview.js
import { previewHandler } from '@headstartwp/next';

export default async function handler(req, res) {
return previewHandler(req, res);
}

Parameters

NameTypeDescription
reqNextApiRequestThe request object,
resNextApiResponse<any>The response object.
optionsPreviewHandlerOptionsThe PreviewHandlerOptions PreviewHandlerOptions

Returns

Promise<void>

A response object.

Defined in

packages/next/src/handlers/previewHandler.ts:120


revalidateHandler

revalidateHandler(req, res): Promise<void>

The RevalidateHandler is responsible for handling revalidate requests.

Handling revalidate requires the Headless WordPress Plugin.

Important: This function is meant to be used in a api route e.g: /pages/api/revalidate.

Usage

// pages/api/revalidate.js
import { revalidateHandler } from '@headstartwp/next';

export default async function handler(req, res) {
return revalidateHandler(req, res);
}

Parameters

NameTypeDescription
reqNextApiRequestThe request object,
resNextApiResponse<any>The response object.

Returns

Promise<void>

A response object.

Defined in

packages/next/src/handlers/revalidateHandler.ts:30

Data Fetching Hooks

useAppSettings

useAppSettings<T, P>(params?, options?): useAppSettingsResponse<T>

The useAppSettings hook

Usage

const { data, loading, error } = useAppSettings();

// check loading and error states

Server-Side-Rendering or Static-Site-Generation

export async function getServerSideProps(context) {
const useAppSettingsData = await fetchHookData(useAppSettings.fetcher(), context);
return addHookData([useAppSettingsData], {});
}

Important: You most likely want to fetch app settings on every route so -that you can access global settings and menus in your pages & components

Type parameters

NameType
Textends AppEntity = AppEntity
Pextends EndpointParams = EndpointParams

Parameters

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T>>Options for the SWR configuration

Returns

useAppSettingsResponse<T>

Defined in

packages/next/src/data/hooks/useAppSettings.ts:33


useAuthorArchive

useAuthorArchive<T, P>(params?, options?): usePostsResponse<T>

The useAuthorArchive hook. Returns a collection of post entities queried by author

This hook must be used with a catch-all route [...path].js (e.g: pages/author/[...path].js)

Important: Use a catch-all and not an optional catch-all route ([[...path]].js) as the author param in the url is required.

In order to automatically map URL params create a catch-all route named [...path].js. -You can create the catch-all at any level e.g: pages/author/[...path].js, etc.

The pages/author/[...path].js route for instance would yield a URL like this: /author-name/page/2, /author-name/category/category-name/page/3, etc.

The following URL params are supported:

  • Category (/author-name/category/category-name)
  • Tag (/author-name/tag/tag-name)
  • Author (/author/author-name)
  • Pagination (/page/2)
  • Custom Taxonomy (/author//taxonomy/term-name)

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T[]>>Options for the SWR configuration

Returns

usePostsResponse<T>

Defined in

packages/next/src/data/hooks/useAuthorArchive.ts:29


useMenu

useMenu(menuLocation, options?): useMenuResponse

The useMenu hooks. Returns a Menu object.

Important: This hook depends on useAppSettings. If you want to enable SSR;SSG for +

Module: @headstartwp/next

Namespaces

Interfaces

API handlers

previewHandler

previewHandler(req, res, options?): Promise<void>

The PreviewHandler is responsible for handling preview requests.

Handling Previews requires the Headless WordPress Plugin.

Important: This function is meant to be used in a api route at /pages/api/preview.

Usage

// pages/api/preview.js
import { previewHandler } from '@headstartwp/next';

export default async function handler(req, res) {
return previewHandler(req, res);
}

Parameters

NameTypeDescription
reqNextApiRequestThe request object,
resNextApiResponse<any>The response object.
optionsPreviewHandlerOptionsThe PreviewHandlerOptions PreviewHandlerOptions

Returns

Promise<void>

A response object.

Defined in

packages/next/src/handlers/previewHandler.ts:120


revalidateHandler

revalidateHandler(req, res): Promise<void>

The RevalidateHandler is responsible for handling revalidate requests.

Handling revalidate requires the Headless WordPress Plugin.

Important: This function is meant to be used in a api route e.g: /pages/api/revalidate.

Usage

// pages/api/revalidate.js
import { revalidateHandler } from '@headstartwp/next';

export default async function handler(req, res) {
return revalidateHandler(req, res);
}

Parameters

NameTypeDescription
reqNextApiRequestThe request object,
resNextApiResponse<any>The response object.

Returns

Promise<void>

A response object.

Defined in

packages/next/src/handlers/revalidateHandler.ts:30

Data Fetching Hooks

useAppSettings

useAppSettings<T, P>(params?, options?): useAppSettingsResponse<T>

The useAppSettings hook

Usage

const { data, loading, error } = useAppSettings();

// check loading and error states

Server-Side-Rendering or Static-Site-Generation

export async function getServerSideProps(context) {
const useAppSettingsData = await fetchHookData(useAppSettings.fetcher(), context);
return addHookData([useAppSettingsData], {});
}

Important: You most likely want to fetch app settings on every route so +that you can access global settings and menus in your pages & components

Type parameters

NameType
Textends AppEntity = AppEntity
Pextends EndpointParams = EndpointParams

Parameters

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T>>Options for the SWR configuration

Returns

useAppSettingsResponse<T>

Defined in

packages/next/src/data/hooks/useAppSettings.ts:33


useAuthorArchive

useAuthorArchive<T, P>(params?, options?): usePostsResponse<T>

The useAuthorArchive hook. Returns a collection of post entities queried by author

This hook must be used with a catch-all route [...path].js (e.g: pages/author/[...path].js)

Important: Use a catch-all and not an optional catch-all route ([[...path]].js) as the author param in the url is required.

In order to automatically map URL params create a catch-all route named [...path].js. +You can create the catch-all at any level e.g: pages/author/[...path].js, etc.

The pages/author/[...path].js route for instance would yield a URL like this: /author-name/page/2, /author-name/category/category-name/page/3, etc.

The following URL params are supported:

  • Category (/author-name/category/category-name)
  • Tag (/author-name/tag/tag-name)
  • Author (/author/author-name)
  • Pagination (/page/2)
  • Custom Taxonomy (/author//taxonomy/term-name)

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T[]>>Options for the SWR configuration

Returns

usePostsResponse<T>

Defined in

packages/next/src/data/hooks/useAuthorArchive.ts:29


useMenu

useMenu(menuLocation, options?): useMenuResponse

The useMenu hooks. Returns a Menu object.

Important: This hook depends on useAppSettings. If you want to enable SSR;SSG for this hook you will need to fetch app settings on the server side.

Usage

Basic usage

export const Nav = () => {
const { data, loading, error } = useMenu('primary-menu');

// handle loading, error states

return <Menu items={data} css={navStyles} />;
}

Re-fetching client-side on focus and/or mount

If you are fetching app settings on the server, you can enable re-fetching on focus and/or mount -to ensure menus are always up-to date even when using SSG/ISR.

export const Nav = () => {
const { data, loading, error } = useMenu('primary-menu', {
revalidateOnFocus: true,
revalidateOnMount: true,
});

// handle loading, error states

return <Menu items={data} css={navStyles} />;
}

Parameters

NameTypeDescription
menuLocationstringThe slug of the menu location you want to fetch
optionsFetchHookOptions<FetchResponse<AppEntity>>SWR configuration options

Returns

useMenuResponse

Defined in

packages/next/src/data/hooks/useMenu.ts:46


usePost

usePost<T, P>(params?, options?): usePostResponse<T>

The usePost hook. Returns a single post entity

In order to automatically map URL params create a catch-all route named [...path].js. -You can create the catch-all at any level e.g: pages/[...path].js, pages/blog/[...path].js, etc.

The pages/[...path].js route for instance would yield a URL like this: /post-slug, /2020/01/01/post-slug, etc.

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostParams = PostParams

Parameters

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T>>Options for the SWR configuration

Returns

usePostResponse<T>

Defined in

packages/next/src/data/hooks/usePost.ts:18


usePostOrPosts

usePostOrPosts<T, P>(params?, options?): usePostOrPostResponse<T>

The usePostOrPosts hook

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostOrPostsParams = PostOrPostsParams

Parameters

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<PostOrPostsFetchStrategyResult<T>>>Options for the SWR configuration

Returns

usePostOrPostResponse<T>

Defined in

packages/next/src/data/hooks/usePostOrPosts.ts:18


usePosts

usePosts<T, P>(params?, options?): usePostsResponse<T>

The usePost hook. Returns a collection of post entities

In order to automatically map URL params create a catch-all route named [[...path]].js. +to ensure menus are always up-to date even when using SSG/ISR.

export const Nav = () => {
const { data, loading, error } = useMenu('primary-menu', {
revalidateOnFocus: true,
revalidateOnMount: true,
});

// handle loading, error states

return <Menu items={data} css={navStyles} />;
}

Parameters

NameTypeDescription
menuLocationstringThe slug of the menu location you want to fetch
optionsFetchHookOptions<FetchResponse<AppEntity>>SWR configuration options

Returns

useMenuResponse

Defined in

packages/next/src/data/hooks/useMenu.ts:46


usePost

usePost<T, P>(params?, options?): usePostResponse<T>

The usePost hook. Returns a single post entity

In order to automatically map URL params create a catch-all route named [...path].js. +You can create the catch-all at any level e.g: pages/[...path].js, pages/blog/[...path].js, etc.

The pages/[...path].js route for instance would yield a URL like this: /post-slug, /2020/01/01/post-slug, etc.

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostParams = PostParams

Parameters

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T>>Options for the SWR configuration

Returns

usePostResponse<T>

Defined in

packages/next/src/data/hooks/usePost.ts:18


usePostOrPosts

usePostOrPosts<T, P>(params?, options?): usePostOrPostResponse<T>

The usePostOrPosts hook

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostOrPostsParams = PostOrPostsParams

Parameters

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<PostOrPostsFetchStrategyResult<T>>>Options for the SWR configuration

Returns

usePostOrPostResponse<T>

Defined in

packages/next/src/data/hooks/usePostOrPosts.ts:18


usePosts

usePosts<T, P>(params?, options?): usePostsResponse<T>

The usePost hook. Returns a collection of post entities

In order to automatically map URL params create a catch-all route named [[...path]].js. You can create the catch-all at any level e.g: pages/[[...path]].js, pages/blog/[[...path]].js, etc.

The pages/blog/[[...path]].js route for instance would yield a URL like this: /blog, /blog/page/2, /blog/category/category-name/page/3, etc.

The following URL params are supported:

  • Category (/category/category-name)
  • Tag (/tag/tag-name)
  • Author (/author/author-name)
  • Pagination (/page/2)
  • Date (/YYYY/MM/DD)
  • Custom Taxonomy (/taxonomy/term-name)

Handling multiple WordPress routes in a single next.js route

The usePosts hook is very flexible and can handle multiple WordPress routes in a single next.js route when using the optional-catch-all route ([[...path]].js). -Alongside with the actual data, usePosts also returns information about the current route so you can conditionally load different components.

const params = { postType: 'post' };
const Posts = () => {
const { data, pageType } = usePosts(params);

if (pageType.isAuthorArchive) {
return <AuthorArchive data={data} />
}

if (pageType.isCategoryArchive) {
return <CategoryArchive data={data} />
}

if (pageType.isTaxonomyArchive && pageType.taxonomy === 'my-custom-taxonomy' ) {
return <TaxonomyArchive data={data} />
}

return (
<div>
<ul>
{data.posts.map((post) => (
<li key={post.id}>
{post.title.rendered}
</li>
))}
</ul>
</div>
);
};

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T[]>>Options for the SWR configuration

Returns

usePostsResponse<T>

Defined in

packages/next/src/data/hooks/usePosts.ts:62


useSearch

useSearch<T, P>(params?, options?): useSearchResponse<T>

The useSearch hook. Returns a collection of search entities

In order to automatically map URL params create a catch-all route named [...path].js. -You can create the catch-all at any level e.g: pages/search/[[...path]].js

The pages/search/[[...path]].js route for instance would yield a URL like this: /search/[term]/page/[number], /search/[term] etc

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T[]>>Options for the SWR configuration

Returns

useSearchResponse<T>

Defined in

packages/next/src/data/hooks/useSearch.ts:18


useSeo

useSeo(format): Record<string, any> | null

The useSeo hook. Returns the current SEO object

Usage

const seo = useSeo();

Parameters

NameTypeDescription
format"json"how to return the seo object. Defaults to 'json'

Returns

Record<string, any> | null

Defined in

packages/next/src/data/hooks/useSeo.ts:18

useSeo(format): string | null

Parameters

NameType
format"html"

Returns

string | null

Defined in

packages/next/src/data/hooks/useSeo.ts:19

useSeo(): Record<string, any> | null

Returns

Record<string, any> | null

Defined in

packages/next/src/data/hooks/useSeo.ts:20


useTerms

useTerms<T, P>(params?, options?): useTermsResponse<T>

The useTerms hook. Returns a collection of term entities

Usage

const { loading, data } = useTerms({ taxonomy: 'category', slug: 'cat-name' });

Type parameters

NameType
Textends TermEntity = TermEntity
Pextends TaxonomyArchiveParams = TaxonomyArchiveParams

Parameters

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T[]>>Options for the SWR configuration

Returns

useTermsResponse<T>

Defined in

packages/next/src/data/hooks/useTerms.ts:19

Next.js Data Fetching Utilities

addHookData

addHookData<P>(_hookStates, nextProps): Object

The addHookData function is responsible for collecting all of the results from the fetchHookData function calls -and prepares the shape of the data to match what the frameworks expects (such as setting initial values for SWR and collecting SEO data).

Usage

export async function getServerSideProps(context) {
try {
const usePostsHook = await fetchHookData(usePosts.fetcher(),context);
const useAppSettingsHook = await fetchHookData(useAppSettings.fetcher(),context);
return addHookData([usePostsHook, useAppSettingsHook], {});
} catch (e) {
return handleError(e, context);
}
}

Type parameters

NameType
P{ [key: string]: any; }

Parameters

NameTypeDescription
_hookStatesHookState<FetchResponse<Entity | Entity[]>>[]
nextPropsNextJSProps<P>Any additional props to pass to Next.js page routes.

Returns

Object

NameType
notFound?boolean
props{ fallback: {} ; seo: { yoast_head: string = seo; yoast_head_json: {} = seo_json } ; themeJSON: {} }
props.fallback{}
props.seo{ yoast_head: string = seo; yoast_head_json: {} = seo_json }
props.seo.yoast_headstring
props.seo.yoast_head_json{}
props.themeJSON{}
redirect?Redirect
revalidate?number | boolean

Defined in

packages/next/src/data/server/addHookData.ts:59


convertToPath

convertToPath(args): string

Creates a path from array of arguments

Parameters

NameTypeDescription
argsundefined | string[]Array of catch-all arguments

Returns

string

Defined in

packages/next/src/data/convertToPath.ts:8


fetchHookData

fetchHookData<T, P, R>(fetchStrategy, ctx, options?): Promise<{ additionalCacheObjects: any ; data: FetchResponse<R> ; isMainQuery: boolean ; key: string }>

A function that implements data fetching on the server. This should be used in getServerSideProps +Alongside with the actual data, usePosts also returns information about the current route so you can conditionally load different components.

const params = { postType: 'post' };
const Posts = () => {
const { data, pageType } = usePosts(params);

if (pageType.isAuthorArchive) {
return <AuthorArchive data={data} />
}

if (pageType.isCategoryArchive) {
return <CategoryArchive data={data} />
}

if (pageType.isTaxonomyArchive && pageType.taxonomy === 'my-custom-taxonomy' ) {
return <TaxonomyArchive data={data} />
}

return (
<div>
<ul>
{data.posts.map((post) => (
<li key={post.id}>
{post.title.rendered}
</li>
))}
</ul>
</div>
);
};

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T[]>>Options for the SWR configuration

Returns

usePostsResponse<T>

Defined in

packages/next/src/data/hooks/usePosts.ts:62


useSearch

useSearch<T, P>(params?, options?): useSearchResponse<T>

The useSearch hook. Returns a collection of search entities

In order to automatically map URL params create a catch-all route named [...path].js. +You can create the catch-all at any level e.g: pages/search/[[...path]].js

The pages/search/[[...path]].js route for instance would yield a URL like this: /search/[term]/page/[number], /search/[term] etc

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T[]>>Options for the SWR configuration

Returns

useSearchResponse<T>

Defined in

packages/next/src/data/hooks/useSearch.ts:18


useSeo

useSeo(format): Record<string, any> | null

The useSeo hook. Returns the current SEO object

Usage

const seo = useSeo();

Parameters

NameTypeDescription
format"json"how to return the seo object. Defaults to 'json'

Returns

Record<string, any> | null

Defined in

packages/next/src/data/hooks/useSeo.ts:18

useSeo(format): string | null

Parameters

NameType
format"html"

Returns

string | null

Defined in

packages/next/src/data/hooks/useSeo.ts:19

useSeo(): Record<string, any> | null

Returns

Record<string, any> | null

Defined in

packages/next/src/data/hooks/useSeo.ts:20


useTerms

useTerms<T, P>(params?, options?): useTermsResponse<T>

The useTerms hook. Returns a collection of term entities

Usage

const { loading, data } = useTerms({ taxonomy: 'category', slug: 'cat-name' });

Type parameters

NameType
Textends TermEntity = TermEntity
Pextends TaxonomyArchiveParams = TaxonomyArchiveParams

Parameters

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T[]>>Options for the SWR configuration

Returns

useTermsResponse<T>

Defined in

packages/next/src/data/hooks/useTerms.ts:19

Next.js Data Fetching Utilities

addHookData

addHookData<P>(_hookStates, nextProps): Object

The addHookData function is responsible for collecting all of the results from the fetchHookData function calls +and prepares the shape of the data to match what the frameworks expects (such as setting initial values for SWR and collecting SEO data).

Usage

export async function getServerSideProps(context) {
try {
const usePostsHook = await fetchHookData(usePosts.fetcher(),context);
const useAppSettingsHook = await fetchHookData(useAppSettings.fetcher(),context);
return addHookData([usePostsHook, useAppSettingsHook], {});
} catch (e) {
return handleError(e, context);
}
}

Type parameters

NameType
P{ [key: string]: any; }

Parameters

NameTypeDescription
_hookStatesHookState<FetchResponse<Entity | Entity[]>>[]
nextPropsNextJSProps<P>Any additional props to pass to Next.js page routes.

Returns

Object

NameType
notFound?boolean
props{ fallback: {} ; seo: { yoast_head: string = seo; yoast_head_json: {} = seo_json } ; themeJSON: {} }
props.fallback{}
props.seo{ yoast_head: string = seo; yoast_head_json: {} = seo_json }
props.seo.yoast_headstring
props.seo.yoast_head_json{}
props.themeJSON{}
redirect?Redirect
revalidate?number | boolean

Defined in

packages/next/src/data/server/addHookData.ts:59


convertToPath

convertToPath(args): string

Creates a path from array of arguments

Parameters

NameTypeDescription
argsundefined | string[]Array of catch-all arguments

Returns

string

Defined in

packages/next/src/data/convertToPath.ts:8


fetchHookData

fetchHookData<T, P, R>(fetchStrategy, ctx, options?): Promise<{ additionalCacheObjects: any ; data: FetchResponse<R> ; isMainQuery: boolean ; key: string }>

A function that implements data fetching on the server. This should be used in getServerSideProps or getStaticProps.

Data fetching will be performed by the specified strategy and URL params will be automatically extracted from `context

Usage

export async function getServerSideProps(context) {
try {
const usePostsHook = await fetchHookData(usePosts.fetcher(),context);

return addHookData([usePostsHook], {});
} catch (e) {
return handleError(e, context);
}
}

@param fetchStrategy The fetch strategy to use. Typically this is exposed by the hook e.g: usePosts.fetcher() @param ctx The Next.js context, either the one from getServerSideProps or getStaticProps -@param options See {@link FetchHookDataOptions}

@returns An object with a key of data and a value of the fetched data.

Type parameters

NameType
Tunknown
Pextends EndpointParams = EndpointParams
RT

Parameters

NameType
fetchStrategyAbstractFetchStrategy<T, P, R>
ctxGetServerSidePropsContext<any, PreviewData> | GetStaticPropsContext<any, PreviewData>
optionsFetchHookDataOptions<P, T>

Returns

Promise<{ additionalCacheObjects: any ; data: FetchResponse<R> ; isMainQuery: boolean ; key: string }>

Defined in

packages/next/src/data/server/fetchHookData.ts:81


handleError

handleError(error, ctx, rootRoute?): Promise<GetServerSidePropsResult<{}>>

The handleError function is responsible for handling errors that occur during +@param options See {@link FetchHookDataOptions}

@returns An object with a key of data and a value of the fetched data.

Type parameters

NameType
Tunknown
Pextends EndpointParams = EndpointParams
RT

Parameters

NameType
fetchStrategyAbstractFetchStrategy<T, P, R>
ctxGetServerSidePropsContext<any, PreviewData> | GetStaticPropsContext<any, PreviewData>
optionsFetchHookDataOptions<P, T>

Returns

Promise<{ additionalCacheObjects: any ; data: FetchResponse<R> ; isMainQuery: boolean ; key: string }>

Defined in

packages/next/src/data/server/fetchHookData.ts:81


handleError

handleError(error, ctx, rootRoute?): Promise<GetServerSidePropsResult<{}>>

The handleError function is responsible for handling errors that occur during data fetching in getServerSideProps or getStaticProps.

It also handles redirects if redirectStrategy is set to 404 in headless.config.js

If error is of type NotFoundError it will redirect to the 404 page. Otherwise it will -return a server error (500) page

Usage

export async function getServerSideProps(context) {
try {
const usePostsHook = await fetchHookData(usePosts.fetcher(),context);
return addHookData([usePostsHook], {});
} catch (e) {
return handleError(e, context);
}
}

Parameters

NameTypeDefault valueDescription
errorErrorundefinedThe error object
ctxHeadlessGetServerSidePropsContext<ParsedUrlQuery> | HeadlessGetStaticPropsPropsContext<ParsedUrlQuery>undefinedThe Next.js context
rootRoutestring''The root route (deprecated/unnecessary). This needs to be revisited

Returns

Promise<GetServerSidePropsResult<{}>>

Defined in

packages/next/src/data/server/handleError.ts:61

Other

HeadlessAppProps

Ƭ HeadlessAppProps: Object

The props supported by HeadlessApp.

Type declaration

NameTypeDescription
children?ReactNode-
handleYoast?booleanIf true, will automatically load yoast seo metadata into the head Default true
pagePropsanyThe page props from next.js. It should contain fallback, themeJson and other props. Those props are added when using fetchHookData and addHookData See - fetchHookData - addHookData
settingsSettingsContextPropsSupported settings by the framework. Such as custom image component, custom link component etc. See SettingsContextProps
swrConfigDataFetchingProviderProps["swrConfig"]Pass any configuration to the SWR library. Globally. These settings can be overridden at the hook level.
useYoastHtml?booleanIf true, will make the Yoast component use the yoast_head raw html to populate meta tags instead of yoast_head_json. yoast_head is the default and preferable option.

Defined in

packages/next/src/components/HeadlessApp.tsx:18


HeadlessGetServerSideProps

Ƭ HeadlessGetServerSideProps<P, Q>: GetServerSideProps<P, Q, PreviewData>

Type parameters

NameType
Pextends Object = { [key: string]: any; }
Qextends ParsedUrlQuery = ParsedUrlQuery

Defined in

packages/next/src/data/types.ts:16


HeadlessGetServerSidePropsContext

Ƭ HeadlessGetServerSidePropsContext<Q>: GetServerSidePropsContext<Q, PreviewData>

Type parameters

NameType
Qextends ParsedUrlQuery = ParsedUrlQuery

Defined in

packages/next/src/data/types.ts:10


HeadlessGetStaticProps

Ƭ HeadlessGetStaticProps<P, Q>: GetStaticProps<P, Q, PreviewData>

Type parameters

NameType
Pextends Object = { [key: string]: any; }
Qextends ParsedUrlQuery = ParsedUrlQuery

Defined in

packages/next/src/data/types.ts:21


HeadlessGetStaticPropsPropsContext

Ƭ HeadlessGetStaticPropsPropsContext<Q>: GetStaticPropsContext<Q, PreviewData>

Type parameters

NameType
Qextends ParsedUrlQuery = ParsedUrlQuery

Defined in

packages/next/src/data/types.ts:13


HookState

Ƭ HookState<T>: Object

Type parameters

Name
T

Type declaration

NameType
additionalCacheObjects?HookState<T>[]
dataT
isMainQueryboolean
keystring

Defined in

packages/next/src/data/server/addHookData.ts:10


NextJSProps

Ƭ NextJSProps<P>: Object

Type parameters

Name
P

Type declaration

NameType
notFound?boolean
props?P
redirect?Redirect
revalidate?number | boolean

Defined in

packages/next/src/data/server/addHookData.ts:17


PreviewData

Ƭ PreviewData: Object

The shape of the preview data that's stored in the preview data cookie

Index signature

[k: string]: unknown

Type declaration

NameTypeDescription
authTokenstringThe auth token that should be used to fetch the data
idnumberThe id of the resource
postTypestringThe post type
revisionbooleanWhether the preview data is on a revision

Defined in

packages/next/src/handlers/types.ts:4


PreviewHandlerOptions

Ƭ PreviewHandlerOptions: Object

The options supported by previewHandler

Type declaration

NameType
getRedirectPath?(defaultRedirectPath: string, post: any, postTypeDef: CustomPostType) => string
onRedirect?(req: NextApiRequest, res: NextApiResponse, previewData: PreviewData, defaultRedirect?: PreviewHandlerOptions["onRedirect"], redirectpath?: string) => void
preparePreviewData?(req: NextApiRequest, res: NextApiResponse, post: PostEntity, previewData: PreviewData) => PreviewData

Defined in

packages/next/src/handlers/previewHandler.ts:11


VIPCustomImageLoader

Ƭ VIPCustomImageLoader: ImageLoaderProps & { aspectRatio?: string }

Defined in

packages/next/src/components/ImageComponent.tsx:30


seoKey

Const seoKey: "@seo"

Defined in

packages/next/src/data/hooks/useSeo.ts:3


VIPImageLoader

VIPImageLoader(props): string

Custom Image loader for WordPress VIP leveraging Photon's API. This can't be made -a global loader because of the local loader used on the custom image component.

Parameters

NameTypeDescription
propsVIPCustomImageLoaderThe loader props

Returns

string

Defined in

packages/next/src/components/ImageComponent.tsx:42


convertUrl

convertUrl(url, hostUrl, sourceUrl): string

Parameters

NameType
urlstring
hostUrlstring
sourceUrlstring

Returns

string

Defined in

packages/next/src/components/Yoast.tsx:15


getPathName

getPathName(resolvedUrl): string

Extracts the path name out of the Next.js resolvedUrl

Parameters

NameTypeDescription
resolvedUrlstringThe full resolved URL

Returns

string

Defined in

packages/next/src/data/server/handleError.ts:23


getSiteFromContext

getSiteFromContext(ctx): HeadlessConfig | { customPostTypes: CustomPostTypes ; customTaxonomies: CustomTaxonomies ; debug: undefined | { devMode?: boolean ; redirects?: boolean ; requests?: boolean } ; hostUrl: string ; integrations: undefined | Integrations ; redirectStrategy: RedirectStrategy ; sites: HeadlessConfig[] ; sourceUrl: undefined | string ; useWordPressPlugin: boolean }

Get site using context

Parameters

NameType
ctxGetServerSidePropsContext<ParsedUrlQuery, PreviewData> | GetStaticPropsContext<ParsedUrlQuery, PreviewData>

Returns

HeadlessConfig | { customPostTypes: CustomPostTypes ; customTaxonomies: CustomTaxonomies ; debug: undefined | { devMode?: boolean ; redirects?: boolean ; requests?: boolean } ; hostUrl: string ; integrations: undefined | Integrations ; redirectStrategy: RedirectStrategy ; sites: HeadlessConfig[] ; sourceUrl: undefined | string ; useWordPressPlugin: boolean }

HeadlessConfig

Defined in

packages/next/src/data/server/getSiteFromContext.ts:10


usePrepareFetch

usePrepareFetch<T, P>(_params?, options?): Object

Prepares params and options for useFetch hooks

Type parameters

NameType
Textends Entity | Entity[]
Pextends EndpointParams

Parameters

NameTypeDescription
_paramsPartial<P>The fetch params
optionsFetchHookOptions<FetchResponse<T>>The fetch options

Returns

Object

NameType
optionsFetchHookOptions<FetchResponse<T>>
paramsPartial<P>
pathstring

Defined in

packages/next/src/data/hooks/usePrepareFetch.ts:13

React Components

HeadlessApp

HeadlessApp(props): Element

The HeadlessApp component is the top level component for the Headless framework.

Should be used in pages/_app.js

Usage

import { HeadlessApp } from "@headstartwp/next";

const MyApp = ({ Component, pageProps }) => {
const { fallback = {}, themeJson = {}, ...props } = pageProps;

return (
<HeadlessApp
pageProps={pageProps}
settings={{
// Pass your own link components here
linkComponent: Link,
}}
>
<Layout>
<Component {...props} />
</Layout>
</HeadlessApp>
);
};

export default MyApp;

Parameters

NameTypeDescription
propsHeadlessAppPropsComponent props. See HeadlessAppProps

Returns

Element

Defined in

packages/next/src/components/HeadlessApp.tsx:96


ImageComponent

ImageComponent(props): Element

An implementation of the ImageBlock (core/image).

If width, height or src are not provided, this component will not be used.

Usage

import { BlocksRenderer, ImageBlock } from "@headstartwp/core/react";
import { ImageComponent } from "@headstartwp/next";

<BlocksRenderer html={html}>
<ImageBlock component={ImageComponent} />
</BlocksRenderer>

Parameters

NameTypeDescription
propsImagePropsImageBlockProps

Returns

Element

Defined in

packages/next/src/components/ImageComponent.tsx:98


LinkBlock

LinkBlock(props): Element

The Link Block converts a anchor tag node into a next/link component if it's an internal link

Usage

import { BlocksRenderer } from "@headstartwp/core/react";
import { LinkBlock } from "@headstartwp/next";

<BlocksRenderer html={html}>
<LinkBlock />
</BlocksRenderer>

Parameters

NameTypeDescription
propsOmit<IBlock<LinkBlockProps>, "component">Link Block Props

Returns

Element

The next/link component

Defined in

packages/next/src/blocks/LinkBlock.tsx:33


TwitterBlock

TwitterBlock(props): Element

Renders a twitter embed

Usage

import { BlocksRenderer } from "@headstartwp/core/react";
import { TwitterBlock } from "@headstartwp/next";

<BlocksRenderer html={html}>
<TwitterBlock />
</BlocksRenderer>

Parameters

NameTypeDescription
propsOmit<IBlock<IBlockAttributes>, "component">Link Block Props

Returns

Element

Defined in

packages/next/src/blocks/TwitterBlock.tsx:25


Yoast

Yoast(props): Element

The Yoast component renders the Yoast SEO meta tags. -This component is automatically rendered by HeadlessApp so you don't have to manually render it.

Parameters

NameTypeDescription
propsPropsComponent props. Expects a single seo prop

Returns

Element

Defined in

packages/next/src/components/Yoast.tsx:61

Finely crafted by 10up, ©2023.

- +return a server error (500) page

Usage

export async function getServerSideProps(context) {
try {
const usePostsHook = await fetchHookData(usePosts.fetcher(),context);
return addHookData([usePostsHook], {});
} catch (e) {
return handleError(e, context);
}
}

Parameters

NameTypeDefault valueDescription
errorErrorundefinedThe error object
ctxHeadlessGetServerSidePropsContext<ParsedUrlQuery> | HeadlessGetStaticPropsPropsContext<ParsedUrlQuery>undefinedThe Next.js context
rootRoutestring''The root route (deprecated/unnecessary). This needs to be revisited

Returns

Promise<GetServerSidePropsResult<{}>>

Defined in

packages/next/src/data/server/handleError.ts:61

Other

HeadlessAppProps

Ƭ HeadlessAppProps: Object

The props supported by HeadlessApp.

Type declaration

NameTypeDescription
children?ReactNode-
handleYoast?booleanIf true, will automatically load yoast seo metadata into the head Default true
pagePropsanyThe page props from next.js. It should contain fallback, themeJson and other props. Those props are added when using fetchHookData and addHookData See - fetchHookData - addHookData
settingsSettingsContextPropsSupported settings by the framework. Such as custom image component, custom link component etc. See SettingsContextProps
swrConfigDataFetchingProviderProps["swrConfig"]Pass any configuration to the SWR library. Globally. These settings can be overridden at the hook level.
useYoastHtml?booleanIf true, will make the Yoast component use the yoast_head raw html to populate meta tags instead of yoast_head_json. yoast_head is the default and preferable option.

Defined in

packages/next/src/components/HeadlessApp.tsx:18


HeadlessGetServerSideProps

Ƭ HeadlessGetServerSideProps<P, Q>: GetServerSideProps<P, Q, PreviewData>

Type parameters

NameType
Pextends Object = { [key: string]: any; }
Qextends ParsedUrlQuery = ParsedUrlQuery

Defined in

packages/next/src/data/types.ts:16


HeadlessGetServerSidePropsContext

Ƭ HeadlessGetServerSidePropsContext<Q>: GetServerSidePropsContext<Q, PreviewData>

Type parameters

NameType
Qextends ParsedUrlQuery = ParsedUrlQuery

Defined in

packages/next/src/data/types.ts:10


HeadlessGetStaticProps

Ƭ HeadlessGetStaticProps<P, Q>: GetStaticProps<P, Q, PreviewData>

Type parameters

NameType
Pextends Object = { [key: string]: any; }
Qextends ParsedUrlQuery = ParsedUrlQuery

Defined in

packages/next/src/data/types.ts:21


HeadlessGetStaticPropsPropsContext

Ƭ HeadlessGetStaticPropsPropsContext<Q>: GetStaticPropsContext<Q, PreviewData>

Type parameters

NameType
Qextends ParsedUrlQuery = ParsedUrlQuery

Defined in

packages/next/src/data/types.ts:13


HookState

Ƭ HookState<T>: Object

Type parameters

Name
T

Type declaration

NameType
additionalCacheObjects?HookState<T>[]
dataT
isMainQueryboolean
keystring

Defined in

packages/next/src/data/server/addHookData.ts:10


NextJSProps

Ƭ NextJSProps<P>: Object

Type parameters

Name
P

Type declaration

NameType
notFound?boolean
props?P
redirect?Redirect
revalidate?number | boolean

Defined in

packages/next/src/data/server/addHookData.ts:17


PreviewData

Ƭ PreviewData: Object

The shape of the preview data that's stored in the preview data cookie

Index signature

[k: string]: unknown

Type declaration

NameTypeDescription
authTokenstringThe auth token that should be used to fetch the data
idnumberThe id of the resource
postTypestringThe post type
revisionbooleanWhether the preview data is on a revision

Defined in

packages/next/src/handlers/types.ts:4


PreviewHandlerOptions

Ƭ PreviewHandlerOptions: Object

The options supported by previewHandler

Type declaration

NameType
getRedirectPath?(defaultRedirectPath: string, post: any, postTypeDef: CustomPostType) => string
onRedirect?(req: NextApiRequest, res: NextApiResponse, previewData: PreviewData, defaultRedirect?: PreviewHandlerOptions["onRedirect"], redirectpath?: string) => void
preparePreviewData?(req: NextApiRequest, res: NextApiResponse, post: PostEntity, previewData: PreviewData) => PreviewData

Defined in

packages/next/src/handlers/previewHandler.ts:11


VIPCustomImageLoader

Ƭ VIPCustomImageLoader: ImageLoaderProps & { aspectRatio?: string }

Defined in

packages/next/src/components/ImageComponent.tsx:30


seoKey

Const seoKey: "@seo"

Defined in

packages/next/src/data/hooks/useSeo.ts:3


VIPImageLoader

VIPImageLoader(props): string

Custom Image loader for WordPress VIP leveraging Photon's API. This can't be made +a global loader because of the local loader used on the custom image component.

Parameters

NameTypeDescription
propsVIPCustomImageLoaderThe loader props

Returns

string

Defined in

packages/next/src/components/ImageComponent.tsx:42


convertUrl

convertUrl(url, hostUrl, sourceUrl): string

Parameters

NameType
urlstring
hostUrlstring
sourceUrlstring

Returns

string

Defined in

packages/next/src/components/Yoast.tsx:15


getPathName

getPathName(resolvedUrl): string

Extracts the path name out of the Next.js resolvedUrl

Parameters

NameTypeDescription
resolvedUrlstringThe full resolved URL

Returns

string

Defined in

packages/next/src/data/server/handleError.ts:23


getSiteFromContext

getSiteFromContext(ctx): HeadlessConfig | { customPostTypes: CustomPostTypes ; customTaxonomies: CustomTaxonomies ; debug: undefined | { devMode?: boolean ; redirects?: boolean ; requests?: boolean } ; hostUrl: string ; integrations: undefined | Integrations ; redirectStrategy: RedirectStrategy ; sites: HeadlessConfig[] ; sourceUrl: undefined | string ; useWordPressPlugin: boolean }

Get site using context

Parameters

NameType
ctxGetServerSidePropsContext<ParsedUrlQuery, PreviewData> | GetStaticPropsContext<ParsedUrlQuery, PreviewData>

Returns

HeadlessConfig | { customPostTypes: CustomPostTypes ; customTaxonomies: CustomTaxonomies ; debug: undefined | { devMode?: boolean ; redirects?: boolean ; requests?: boolean } ; hostUrl: string ; integrations: undefined | Integrations ; redirectStrategy: RedirectStrategy ; sites: HeadlessConfig[] ; sourceUrl: undefined | string ; useWordPressPlugin: boolean }

HeadlessConfig

Defined in

packages/next/src/data/server/getSiteFromContext.ts:10


usePrepareFetch

usePrepareFetch<T, P>(_params?, options?): Object

Prepares params and options for useFetch hooks

Type parameters

NameType
Textends Entity | Entity[]
Pextends EndpointParams

Parameters

NameTypeDescription
_paramsPartial<P>The fetch params
optionsFetchHookOptions<FetchResponse<T>>The fetch options

Returns

Object

NameType
optionsFetchHookOptions<FetchResponse<T>>
paramsPartial<P>
pathstring

Defined in

packages/next/src/data/hooks/usePrepareFetch.ts:13

React Components

HeadlessApp

HeadlessApp(props): Element

The HeadlessApp component is the top level component for the Headless framework.

Should be used in pages/_app.js

Usage

import { HeadlessApp } from "@headstartwp/next";

const MyApp = ({ Component, pageProps }) => {
const { fallback = {}, themeJson = {}, ...props } = pageProps;

return (
<HeadlessApp
pageProps={pageProps}
settings={{
// Pass your own link components here
linkComponent: Link,
}}
>
<Layout>
<Component {...props} />
</Layout>
</HeadlessApp>
);
};

export default MyApp;

Parameters

NameTypeDescription
propsHeadlessAppPropsComponent props. See HeadlessAppProps

Returns

Element

Defined in

packages/next/src/components/HeadlessApp.tsx:96


ImageComponent

ImageComponent(props): Element

An implementation of the ImageBlock (core/image).

If width, height or src are not provided, this component will not be used.

Usage

import { BlocksRenderer, ImageBlock } from "@headstartwp/core/react";
import { ImageComponent } from "@headstartwp/next";

<BlocksRenderer html={html}>
<ImageBlock component={ImageComponent} />
</BlocksRenderer>

Parameters

NameTypeDescription
propsImagePropsImageBlockProps

Returns

Element

Defined in

packages/next/src/components/ImageComponent.tsx:98


LinkBlock

LinkBlock(props): Element

The Link Block converts a anchor tag node into a next/link component if it's an internal link

Usage

import { BlocksRenderer } from "@headstartwp/core/react";
import { LinkBlock } from "@headstartwp/next";

<BlocksRenderer html={html}>
<LinkBlock />
</BlocksRenderer>

Parameters

NameTypeDescription
propsOmit<IBlock<LinkBlockProps>, "component">Link Block Props

Returns

Element

The next/link component

Defined in

packages/next/src/blocks/LinkBlock.tsx:33


TwitterBlock

TwitterBlock(props): Element

Renders a twitter embed

Usage

import { BlocksRenderer } from "@headstartwp/core/react";
import { TwitterBlock } from "@headstartwp/next";

<BlocksRenderer html={html}>
<TwitterBlock />
</BlocksRenderer>

Parameters

NameTypeDescription
propsOmit<IBlock<IBlockAttributes>, "component">Link Block Props

Returns

Element

Defined in

packages/next/src/blocks/TwitterBlock.tsx:25


Yoast

Yoast(props): Element

The Yoast component renders the Yoast SEO meta tags. +This component is automatically rendered by HeadlessApp so you don't have to manually render it.

Parameters

NameTypeDescription
propsPropsComponent props. Expects a single seo prop

Returns

Element

Defined in

packages/next/src/components/Yoast.tsx:61

+ \ No newline at end of file diff --git a/api/namespaces/headstartwp_core.react/index.html b/api/namespaces/headstartwp_core.react/index.html index 453a1a196..fc2dddd5d 100644 --- a/api/namespaces/headstartwp_core.react/index.html +++ b/api/namespaces/headstartwp_core.react/index.html @@ -7,17 +7,17 @@ - +
-
Skip to main content

Namespace: react

@headstartwp/core.react

@headstartwp/core/react

The react export of the @headstartwp/core package.

Usage

import { BlocksRenderer } from "@headstartwp/core/react";

Interfaces

Blocks

AudioBlock

AudioBlock(props): Element

The AudioBlock components implements block parsing for the Audio block.

This component must be used within a BlocksRenderer component.

<BlocksRenderer html={html}>
<AudioBlock component={DebugComponent} />
</BlocksRenderer>

Parameters

NameTypeDescription
propsIAudioBlockComponent properties

Returns

Element

Defined in

packages/core/src/react/blocks/AudioBlock.tsx:58


ButtonBlock

ButtonBlock(props): Element

The ButtonBlock component implements block parsing for the Button block.

This component must be used within a BlocksRenderer component.

<BlocksRenderer html={html}>
<ButtonBlock component={DebugComponent} />
</BlocksRenderer>

Parameters

NameTypeDescription
propsIButtonBlockComponent properties

Returns

Element

Defined in

packages/core/src/react/blocks/ButtonBlock.tsx:62


ButtonsBlock

ButtonsBlock(props): Element

The ButtonsBlock component implements block parsing for the Buttons block.

This component must be used within a BlocksRenderer component.

<BlocksRenderer html={html}>
<ButtonsBlock component={DebugComponent} />
</BlocksRenderer>

Parameters

NameTypeDescription
propsIButtonsBlockComponent properties

Returns

Element

Defined in

packages/core/src/react/blocks/ButtonsBlock.tsx:28


CodeBlock

CodeBlock(props): Element

The CodeBlock component implements block parsing for the core/code block.

This component must be used within a BlocksRenderer component.

<BlocksRenderer html={html}>
<CodeBlock component={DebugComponent} />
</BlocksRenderer>

Parameters

NameTypeDescription
propsICodeBlockComponent properties

Returns

Element

Defined in

packages/core/src/react/blocks/CodeBlock.tsx:32

Data Fetching Hooks

useFetch

useFetch<E, Params, R>(params, fetchStrategy, options?, path?): Object

The use Fetch Hook is the foundation for most hooks in the headless framework. It is a wrapper around +

Namespace: react

@headstartwp/core.react

@headstartwp/core/react

The react export of the @headstartwp/core package.

Usage

import { BlocksRenderer } from "@headstartwp/core/react";

Interfaces

Blocks

AudioBlock

AudioBlock(props): Element

The AudioBlock components implements block parsing for the Audio block.

This component must be used within a BlocksRenderer component.

<BlocksRenderer html={html}>
<AudioBlock component={DebugComponent} />
</BlocksRenderer>

Parameters

NameTypeDescription
propsIAudioBlockComponent properties

Returns

Element

Defined in

packages/core/src/react/blocks/AudioBlock.tsx:58


ButtonBlock

ButtonBlock(props): Element

The ButtonBlock component implements block parsing for the Button block.

This component must be used within a BlocksRenderer component.

<BlocksRenderer html={html}>
<ButtonBlock component={DebugComponent} />
</BlocksRenderer>

Parameters

NameTypeDescription
propsIButtonBlockComponent properties

Returns

Element

Defined in

packages/core/src/react/blocks/ButtonBlock.tsx:62


ButtonsBlock

ButtonsBlock(props): Element

The ButtonsBlock component implements block parsing for the Buttons block.

This component must be used within a BlocksRenderer component.

<BlocksRenderer html={html}>
<ButtonsBlock component={DebugComponent} />
</BlocksRenderer>

Parameters

NameTypeDescription
propsIButtonsBlockComponent properties

Returns

Element

Defined in

packages/core/src/react/blocks/ButtonsBlock.tsx:28


CodeBlock

CodeBlock(props): Element

The CodeBlock component implements block parsing for the core/code block.

This component must be used within a BlocksRenderer component.

<BlocksRenderer html={html}>
<CodeBlock component={DebugComponent} />
</BlocksRenderer>

Parameters

NameTypeDescription
propsICodeBlockComponent properties

Returns

Element

Defined in

packages/core/src/react/blocks/CodeBlock.tsx:32

Data Fetching Hooks

useFetch

useFetch<E, Params, R>(params, fetchStrategy, options?, path?): Object

The use Fetch Hook is the foundation for most hooks in the headless framework. It is a wrapper around useSWR and provides a consistent API for fetching data from the API. It requires a fetch strategy which implements -the actual data fetching logic

Type parameters

NameType
EE
Paramsextends EndpointParams
RE

Parameters

NameTypeDefault valueDescription
params{} | ParamsundefinedThe list of params to pass to the fetch strategy. It overrides the ones in the URL.
fetchStrategyAbstractFetchStrategy<E, Params, R>undefinedThe fetch strategy.
optionsFetchHookOptions<FetchResponse<R>>{}The options to pass to the swr hook.
pathstring''The path of the url to get url params from.

Returns

Object

NameTypeDescription
dataundefined | FetchResponse<R>The returned data of the fetcher function.
erroranyThe error object thrown by the fetcher function.
isLoadingboolean-
isMainQueryboolean-
isValidatingboolean-
mutateKeyedMutator<FetchResponse<R>>-
paramsPartial<Params>-

Defined in

packages/core/src/react/hooks/useFetch.ts:30


useFetchAppSettings

useFetchAppSettings<T, P>(params?, options?): useAppSettingsResponse<T>

The useAppSettings hook

See useAppSettings

Type parameters

NameType
Textends AppEntity = AppEntity
Pextends EndpointParams = EndpointParams

Parameters

NameTypeDescription
params{} | PThe list of params to pass to the fetch strategy. It overrides the ones in the URL.
optionsFetchHookOptions<FetchResponse<T>>The options to pass to the swr hook.

Returns

useAppSettingsResponse<T>

Defined in

packages/core/src/react/hooks/useFetchAppSettings.ts:21


useFetchMenu

useFetchMenu(menuLocation, options?): useMenuResponse

The useFetchMenu hooks. Returns a Menu object.

Parameters

NameTypeDescription
menuLocationstringThe slug of the menu location you want to fetch
optionsFetchHookOptions<FetchResponse<AppEntity>>SWR configuration options

Returns

useMenuResponse

Defined in

packages/core/src/react/hooks/useFetchMenu.ts:50


useFetchPosts

useFetchPosts<T, P>(params?, options?, path?, fetcher?): usePostsResponse<T>

The useFetchPosts hook. Returns a collection of post entities

See usePosts for usage instructions.

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters

NameTypeDefault valueDescription
params{} | P{}The list of params to pass to the fetch strategy. It overrides the ones in the URL.
optionsFetchHookOptions<FetchResponse<T[]>>{}The options to pass to the swr hook.
pathstring''The path of the url to get url params from.
fetcherundefined | PostsArchiveFetchStrategy<T, P>undefinedThe fetch strategy to use. If none is passed, the default one is used

Returns

usePostsResponse<T>

Defined in

packages/core/src/react/hooks/useFetchPosts.ts:79


useFetchSearch

useFetchSearch<T, P>(params?, options?, path?): useSearchResponse<T>

The useFetchSearch hook. Returns a collection of post entities

See useSearch for usage instructions.

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters

NameTypeDefault valueDescription
params{} | P{}The list of params to pass to the fetch strategy. It overrides the ones in the URL.
optionsFetchHookOptions<FetchResponse<T[]>>{}The options to pass to the swr hook.
pathstring''The path of the url to get url params from.

Returns

useSearchResponse<T>

Defined in

packages/core/src/react/hooks/useFetchSearch.ts:32


useFetchTerms

useFetchTerms<T, P>(params, options?, path?): useTermsResponse<T>

The useFetchTerms hook. Returns a collection of term entities

See useTerms for usage instructions.

Type parameters

NameType
Textends TermEntity = TermEntity
Pextends TaxonomyArchiveParams = TaxonomyArchiveParams

Parameters

NameTypeDefault valueDescription
params{} | PundefinedThe list of params to pass to the fetch strategy. It overrides the ones in the URL.
optionsFetchHookOptions<FetchResponse<T[]>>{}The options to pass to the swr hook.
pathstring''The path of the url to get url params from.

Returns

useTermsResponse<T>

Defined in

packages/core/src/react/hooks/useFetchTerms.ts:29

Other

Align

Ƭ Align: "none" | "left" | "center" | "right" | "wide" | "full"

Defined in

packages/core/src/react/blocks/types.ts:15


Border

Ƭ Border: Object

Type declaration

NameType
radius?string
style?string
width?string

Defined in

packages/core/src/react/blocks/types.ts:65


DataFetchingProviderProps

Ƭ DataFetchingProviderProps: Object

Type declaration

NameTypeDescription
dataSWRConfiguration["fallback"]-
swrConfigSWRConfigurationPass any configuration to the SWR library. Globally. These settings can be overridden at the hook level.

Defined in

packages/core/src/react/provider/DataFetchingProvider.tsx:6


ItemWrapper

Ƭ ItemWrapper: (props: ItemWrapperProps) => JSX.Element

Type declaration

▸ (props): JSX.Element

Parameters
NameType
propsItemWrapperProps
Returns

JSX.Element

Defined in

packages/core/src/react/components/Menu.tsx:15


ItemWrapperProps

Ƭ ItemWrapperProps: PropsWithChildren<{ className: string ; depth: number ; item: MenuItemEntity }>

Defined in

packages/core/src/react/components/Menu.tsx:10


Ƭ LinkWrapper: (props: LinkWrapperProps) => JSX.Element

Type declaration

▸ (props): JSX.Element

Parameters
NameType
propsLinkWrapperProps
Returns

JSX.Element

Defined in

packages/core/src/react/components/Menu.tsx:27


LinkWrapperProps

Ƭ LinkWrapperProps: PropsWithChildren<{ depth: number ; href: string }>

Defined in

packages/core/src/react/components/Menu.tsx:23


Ƭ MenuItemsProp: Object

Type declaration

NameType
depthnumber
itemWrapperItemWrapper
itemsMenuItemEntity[]
linkWrapperLinkWrapper
menuWrapperMenuWrapper
topLevelItemsClickableboolean

Defined in

packages/core/src/react/components/Menu.tsx:29


Ƭ MenuWrapper: (props: MenuWrapperProps) => JSX.Element

Type declaration

▸ (props): JSX.Element

Parameters
NameType
propsMenuWrapperProps
Returns

JSX.Element

Defined in

packages/core/src/react/components/Menu.tsx:21


Ƭ MenuWrapperProps: PropsWithChildren<{ className: string ; depth: number }>

Defined in

packages/core/src/react/components/Menu.tsx:17


PageType

Ƭ PageType: Object

Type declaration

NameTypeDescription
isAuthorArchivebooleanAuthor Archive
isCategoryArchivebooleanCategory Archive
isPostArchivebooleanRegular post archive
isPostTypeArchivebooleanCustom Post Type Archive
isSearchbooleanSearch route
isTagArchivebooleanTag Archive
isTaxonomyArchivebooleanCustom Taxonomy Archive
postTypestringWhich post type this archive is for
taxonomystringWhich taxonomy this archive is for

Defined in

packages/core/src/react/hooks/useFetchPosts.ts:19


SettingsColorPalette

Ƭ SettingsColorPalette: Object

Type declaration

NameType
default?SettingsColorPreset[]
theme?SettingsColorPreset[]
user?SettingsColorPreset[]

Defined in

packages/core/src/react/provider/types.ts:47


SettingsColorPreset

Ƭ SettingsColorPreset: Object

Type declaration

NameTypeDescription
colorstringCSS hex or rgb(a) string.
namestringName of the color preset, translatable.
slugstringKebab-case unique identifier for the color preset.

Defined in

packages/core/src/react/provider/types.ts:32


SettingsContextProps

Ƭ SettingsContextProps: { imageComponent?: React.FC<IImageBlock> ; linkComponent?: ReactNode } & HeadlessConfig

Defined in

packages/core/src/react/provider/types.ts:5


SettingsDuotone

Ƭ SettingsDuotone: Object

Type declaration

NameType
default?SettingsDuotonePreset[]
theme?SettingsDuotonePreset[]
user?SettingsDuotonePreset[]

Defined in

packages/core/src/react/provider/types.ts:89


SettingsDuotonePreset

Ƭ SettingsDuotonePreset: Object

Type declaration

NameTypeDescription
colorsstring[]List of colors from dark to light.
namestringName of the duotone preset, translatable.
slugstringKebab-case unique identifier for the duotone preset.

Defined in

packages/core/src/react/provider/types.ts:74


SettingsGradient

Ƭ SettingsGradient: Object

Type declaration

NameType
default?SettingsGradientPreset[]
theme?SettingsGradientPreset[]
user?SettingsGradientPreset[]

Defined in

packages/core/src/react/provider/types.ts:68


SettingsGradientPreset

Ƭ SettingsGradientPreset: Object

Type declaration

NameTypeDescription
gradientstringCSS gradient string.
namestringName of the gradient preset, translatable.
slugstringKebab-case unique identifier for the gradient preset.

Defined in

packages/core/src/react/provider/types.ts:53


SettingsPropertiesComplete

Ƭ SettingsPropertiesComplete: SettingsProperties & { border?: SettingsProperties["border"] ; color?: SettingsProperties["color"] ; custom?: SettingsProperties["custom"] ; layout?: SettingsProperties["layout"] ; spacing?: SettingsProperties["spacing"] ; typography?: SettingsProperties["typography"] }

Defined in

packages/core/src/react/provider/types.ts:10


Spacing

Ƭ Spacing: Object

Type declaration

NameType
blockGapstring
margin{ bottom: string ; left: string ; right: string ; top: string }
margin.bottomstring
margin.leftstring
margin.rightstring
margin.topstring
padding{ bottom: string ; left: string ; right: string ; top: string }
padding.bottomstring
padding.leftstring
padding.rightstring
padding.topstring
supportsBlockGapboolean
supportsMarginboolean
supportsPaddingboolean

Defined in

packages/core/src/react/blocks/types.ts:40


Style

Ƭ Style: Object

Type declaration

NameType
borderBorder
spacingSpacing
typographyTypography

Defined in

packages/core/src/react/blocks/types.ts:17


StylesPropertiesAndElementsComplete

Ƭ StylesPropertiesAndElementsComplete: StylesProperties & { border?: SettingsProperties["border"] ; color?: SettingsProperties["color"] ; elements?: StylesElementsPropertiesComplete ; spacing?: SettingsProperties["spacing"] ; typography?: SettingsProperties["typography"] }

Defined in

packages/core/src/react/provider/types.ts:24


StylesPropertiesComplete

Ƭ StylesPropertiesComplete: StylesProperties & { border?: SettingsProperties["border"] ; color?: SettingsProperties["color"] ; spacing?: SettingsProperties["spacing"] ; typography?: SettingsProperties["typography"] }

Defined in

packages/core/src/react/provider/types.ts:18


ThemeJSON

Ƭ ThemeJSON: Pick<WpThemeJSON, "styles" | "settings">

Defined in

packages/core/src/react/provider/types.ts:352


SettingsContext

Const SettingsContext: Context<Partial<SettingsContextProps>>

Defined in

packages/core/src/react/provider/Provider.tsx:5


ThemeSettingsContext

Const ThemeSettingsContext: Context<ThemeJSON>

Defined in

packages/core/src/react/provider/ThemeSettingsProvider.tsx:4


defaultElement

Const defaultElement: Element

Defined in

packages/core/src/react/blocks/hooks/useBlock.ts:8


ColumnBlock

ColumnBlock(«destructured»): Element

Parameters

NameType
«destructured»IColumnBlock

Returns

Element

Defined in

packages/core/src/react/blocks/ColumnBlock.tsx:11


ColumnsBlock

ColumnsBlock(«destructured»): Element

Parameters

NameType
«destructured»IColumnsBlock

Returns

Element

Defined in

packages/core/src/react/blocks/ColumnsBlocks.tsx:11


CoverBlock

CoverBlock(«destructured»): Element

Parameters

NameType
«destructured»ICoverBlock

Returns

Element

Defined in

packages/core/src/react/blocks/CoverBlock.tsx:24


DataFetchingProvider

DataFetchingProvider(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<DataFetchingProviderProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/@types/react/index.d.ts:542


DebugBlock

DebugBlock(«destructured»): Element

Parameters

NameType
«destructured»Object

Returns

Element

Defined in

packages/core/src/react/blocks/DebugBlock.tsx:7


FileBlock

FileBlock(«destructured»): Element

Parameters

NameType
«destructured»IFileBlock

Returns

Element

Defined in

packages/core/src/react/blocks/FileBlock.tsx:14


GroupBlock

GroupBlock(«destructured»): Element

Parameters

NameType
«destructured»IGroupBlock

Returns

Element

Defined in

packages/core/src/react/blocks/GroupBlock.tsx:17


HeadingBlock

HeadingBlock(«destructured»): Element

Parameters

NameType
«destructured»IHeadingBlock

Returns

Element

Defined in

packages/core/src/react/blocks/HeadingBlock.tsx:12


ImageBlock

ImageBlock(«destructured»): Element

Parameters

NameType
«destructured»IImageBlock

Returns

Element

Defined in

packages/core/src/react/blocks/ImageBlock.tsx:19


ListBlock

ListBlock(«destructured»): Element

Parameters

NameType
«destructured»IListBlock

Returns

Element

Defined in

packages/core/src/react/blocks/ListBlock.tsx:12


MediaTextBlock

MediaTextBlock(«destructured»): Element

Parameters

NameType
«destructured»IMediaTextBlock

Returns

Element

Defined in

packages/core/src/react/blocks/MediaTextBlock.tsx:22


Menu(«destructured»): Element

Parameters

NameType
«destructured»MenuProps

Returns

Element

Defined in

packages/core/src/react/components/Menu.tsx:109


MenuItems(«destructured»): Element

Parameters

NameType
«destructured»MenuItemsProp

Returns

Element

Defined in

packages/core/src/react/components/Menu.tsx:54


ParagraphBlock

ParagraphBlock(«destructured»): Element

Parameters

NameType
«destructured»IParagraphBlock

Returns

Element

Defined in

packages/core/src/react/blocks/ParagraphBlock.tsx:13


PreformattedBlock

PreformattedBlock(«destructured»): Element

Parameters

NameType
«destructured»IPreformattedBlock

Returns

Element

Defined in

packages/core/src/react/blocks/PreformatedBlock.tsx:11


PullQuoteBlock

PullQuoteBlock(«destructured»): Element

Parameters

NameType
«destructured»IPullQuoteBlock

Returns

Element

Defined in

packages/core/src/react/blocks/PullQuote.tsx:15


QuoteBlock

QuoteBlock(«destructured»): Element

Parameters

NameType
«destructured»IQuoteBlock

Returns

Element

Defined in

packages/core/src/react/blocks/QuoteBlock.tsx:10


SeparatorBlock

SeparatorBlock(«destructured»): Element

Parameters

NameType
«destructured»ISeparatorBlock

Returns

Element

Defined in

packages/core/src/react/blocks/SeparatorBlock.tsx:10


SettingsProvider

SettingsProvider(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<ProviderProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/@types/react/index.d.ts:542


SpacerBlock

SpacerBlock(«destructured»): Element

Parameters

NameType
«destructured»ISpacerBlock

Returns

Element

Defined in

packages/core/src/react/blocks/SpacerBlock.tsx:12


TableBlock

TableBlock(«destructured»): Element

Parameters

NameType
«destructured»ITableBlock

Returns

Element

Defined in

packages/core/src/react/blocks/TableBlock.tsx:12


ThemeSettingsProvider

ThemeSettingsProvider(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<ProviderProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/@types/react/index.d.ts:542


VerseBlock

VerseBlock(«destructured»): Element

Parameters

NameType
«destructured»IVerseBlock

Returns

Element

Defined in

packages/core/src/react/blocks/VerseBlock.tsx:11


YoutubeLiteBlock

YoutubeLiteBlock(props): Element

Renders Youtube embeds with lite-youtube-embed

Parameters

NameTypeDescription
propsOmit<IYoutubeLiteBlock, "component">The Block props

Returns

Element

Defined in

packages/core/src/react/blocks/YoutubeLiteBlock.tsx:41


getAlignStyle

getAlignStyle(domNode): "none" | "left" | "center" | "right" | "wide" | "full"

Parameters

NameType
domNodeElement

Returns

"none" | "left" | "center" | "right" | "wide" | "full"

Defined in

packages/core/src/react/blocks/utils.ts:5


getBlockStyle

getBlockStyle(domNode): string

Returns the block style (is-style-{block-style})

Parameters

NameTypeDescription
domNodeElementDomNode

Returns

string

string with block style

Defined in

packages/core/src/react/blocks/utils.ts:39


getColorStyles

getColorStyles(domNode): Colors

Infer GB color styles from classnames

Parameters

NameTypeDescription
domNodeElementDomNode

Returns

Colors

ColorBlockProps object

Defined in

packages/core/src/react/blocks/utils.ts:62


getInlineStyles

getInlineStyles(domNode): false | Record<string, string>

Converts inline styles to a stylesObject for use in react components

Parameters

NameTypeDescription
domNodeElementDomNode

Returns

false | Record<string, string>

Defined in

packages/core/src/react/blocks/utils.ts:120


getTypographyStyles

getTypographyStyles(domNode): Object

Returns the typography styles of a block

Parameters

NameTypeDescription
domNodeElementDomNode

Returns

Object

NameType
fontSizestring
style{ fontSize: string = ''; lineHeight: string = '' }
style.fontSizestring
style.lineHeightstring

Defined in

packages/core/src/react/blocks/utils.ts:177


getWidthStyles

getWidthStyles(domNode): undefined | string

Returns the width size of a block

Parameters

NameTypeDescription
domNodeElementDomNode

Returns

undefined | string

Defined in

packages/core/src/react/blocks/utils.ts:149


parseSeo

parseSeo(seo, options?): string | Element | Element[]

Parameters

NameType
seostring
optionsHTMLReactParserOptions

Returns

string | Element | Element[]

Defined in

packages/core/src/react/utils/parseSeo.ts:4


safeArraySpread

safeArraySpread(array): any[]

Parameters

NameType
arrayany

Returns

any[]

Defined in

packages/core/src/react/blocks/utils.ts:220


serializeKey

serializeKey(key): string

Parameters

NameType
keyKey

Returns

string

Defined in

node_modules/swr/core/dist/index.d.ts:17


useBlock

useBlock<T>(node?): Object

Returns the block name and attributes

Type parameters

NameType
Textends IBlockAttributes

Parameters

NameTypeDescription
node?ElementDomNode

Returns

Object

NameType
attributesT
classNamestring
namestring

Defined in

packages/core/src/react/blocks/hooks/useBlock.ts:38


useBlockAlign

useBlockAlign(node): Align

Returns the block align style (if available)

Parameters

NameTypeDescription
nodeElementDomNode

Returns

Align

Defined in

packages/core/src/react/blocks/hooks/useBlockAlign.ts:16


useBlockAttributes

useBlockAttributes(node?): Object

useBlockAttributes hooks returns the block attributes for a given block based on what it supports

Parameters

NameTypeDescription
node?ElementThe reference to the dom node of the block

Returns

Object

NameType
alignAlign
blockStylestring
borderBorder
colorsColors
spacingSpacing
typographyTypography
widthundefined | string

Defined in

packages/core/src/react/blocks/hooks/useBlockAttributes.ts:19


useBlockBorder

useBlockBorder(node): Border

Returns the block style (if available)

Parameters

NameTypeDescription
nodeElementDomNode

Returns

Border

Defined in

packages/core/src/react/blocks/hooks/useBlockBorder.ts:17


useBlockColors

useBlockColors(node): Colors

Returns the block style (if available)

Parameters

NameTypeDescription
nodeElementDomNode

Returns

Colors

Defined in

packages/core/src/react/blocks/hooks/useBlockColors.ts:25


useBlockSpacing

useBlockSpacing(node): Spacing

Returns the block style (if available)

Parameters

NameTypeDescription
nodeElementDomNode

Returns

Spacing

Defined in

packages/core/src/react/blocks/hooks/useBlockSpacing.ts:21


useBlockStyle

useBlockStyle(node): string

Returns the block style (if available)

Parameters

NameTypeDescription
nodeElementDomNode

Returns

string

Defined in

packages/core/src/react/blocks/hooks/useBlockStyle.ts:10


useBlockTypography

useBlockTypography(node): Typography

Returns the block style (if available)

Parameters

NameTypeDescription
nodeElementDomNode

Returns

Typography

Defined in

packages/core/src/react/blocks/hooks/useBlockTypography.ts:25


useBlockWidth

useBlockWidth(node): undefined | string

Returns the block style (if available)

Parameters

NameTypeDescription
nodeElementDomNode

Returns

undefined | string

Defined in

packages/core/src/react/blocks/hooks/useBlockWidth.ts:16


useFetchAuthorArchive

useFetchAuthorArchive<T, P>(params?, options?, path?): usePostsResponse<T>

The useFetchAuthorArchive hook

See useAuthorArchive

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters

NameTypeDefault valueDescription
params{} | PostEntity{}The list of params to pass to the fetch strategy. It overrides the ones in the URL.
optionsFetchHookOptions<FetchResponse<T[]>>{}The options to pass to the swr hook.
pathstring''The path of the url to get url params from.

Returns

usePostsResponse<T>

Defined in

packages/core/src/react/hooks/useFetchAuthorArchive.ts:22


useFetchPost

useFetchPost<T, P>(params?, options?, path?): usePostResponse<T>

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostParams = PostParams

Parameters

NameTypeDefault value
params{} | P{}
optionsFetchHookOptions<FetchResponse<T>>{}
pathstring''

Returns

usePostResponse<T>

Defined in

packages/core/src/react/hooks/useFetchPost.ts:30


useFetchPostOrPosts

useFetchPostOrPosts<T, P>(params?, options?, path?): usePostOrPostResponse<T>

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostOrPostsParams = PostOrPostsParams

Parameters

NameTypeDefault value
paramsPartial<P>{}
optionsFetchHookOptions<FetchResponse<PostOrPostsFetchStrategyResult<T>>>{}
pathstring''

Returns

usePostOrPostResponse<T>

Defined in

packages/core/src/react/hooks/useFetchPostOrPosts.ts:32


useSWR

useSWR<Data, Error, SWRKey>(key): SWRResponse<Data, Error, any>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
const { data, error } = useSWR('/api/user', fetcher)
if (error) return <div>failed to load</div>
if (!data) return <div>loading...</div>
return <div>hello {data.name}!</div>
}

Type parameters

NameType
Dataany
Errorany
SWRKeyextends Key = StrictKey

Parameters

NameType
keySWRKey

Returns

SWRResponse<Data, Error, any>

Defined in

node_modules/swr/_internal/dist/index.d.ts:200

useSWR<Data, Error, SWRKey>(key, fetcher): SWRResponse<Data, Error, any>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
const { data, error } = useSWR('/api/user', fetcher)
if (error) return <div>failed to load</div>
if (!data) return <div>loading...</div>
return <div>hello {data.name}!</div>
}

Type parameters

NameType
Dataany
Errorany
SWRKeyextends Key = StrictKey

Parameters

NameType
keySWRKey
fetchernull | Fetcher<Data, SWRKey>

Returns

SWRResponse<Data, Error, any>

Defined in

node_modules/swr/_internal/dist/index.d.ts:201

useSWR<Data, Error, SWRKey, SWROptions>(key, config): SWRResponse<Data, Error, SWROptions>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
const { data, error } = useSWR('/api/user', fetcher)
if (error) return <div>failed to load</div>
if (!data) return <div>loading...</div>
return <div>hello {data.name}!</div>
}

Type parameters

NameType
Dataany
Errorany
SWRKeyextends Key = StrictKey
SWROptionsextends undefined | Partial<PublicConfiguration<Data, Error, Fetcher<Data, SWRKey>>> = undefined | Partial<PublicConfiguration<Data, Error, Fetcher<Data, SWRKey>>>

Parameters

NameType
keySWRKey
configSWROptions

Returns

SWRResponse<Data, Error, SWROptions>

Defined in

node_modules/swr/_internal/dist/index.d.ts:202

useSWR<Data, Error, SWRKey, SWROptions>(key, fetcher, config): SWRResponse<Data, Error, SWROptions>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
const { data, error } = useSWR('/api/user', fetcher)
if (error) return <div>failed to load</div>
if (!data) return <div>loading...</div>
return <div>hello {data.name}!</div>
}

Type parameters

NameType
Dataany
Errorany
SWRKeyextends Key = StrictKey
SWROptionsextends undefined | Partial<PublicConfiguration<Data, Error, Fetcher<Data, SWRKey>>> = undefined | Partial<PublicConfiguration<Data, Error, Fetcher<Data, SWRKey>>>

Parameters

NameType
keySWRKey
fetchernull | Fetcher<Data, SWRKey>
configSWROptions

Returns

SWRResponse<Data, Error, SWROptions>

Defined in

node_modules/swr/_internal/dist/index.d.ts:203

useSWR<Data, Error>(key): SWRResponse<Data, Error, any>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
const { data, error } = useSWR('/api/user', fetcher)
if (error) return <div>failed to load</div>
if (!data) return <div>loading...</div>
return <div>hello {data.name}!</div>
}

Type parameters

NameType
Dataany
Errorany

Parameters

NameType
keyKey

Returns

SWRResponse<Data, Error, any>

Defined in

node_modules/swr/_internal/dist/index.d.ts:204

useSWR<Data, Error>(key, fetcher): SWRResponse<Data, Error, any>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
const { data, error } = useSWR('/api/user', fetcher)
if (error) return <div>failed to load</div>
if (!data) return <div>loading...</div>
return <div>hello {data.name}!</div>
}

Type parameters

NameType
Dataany
Errorany

Parameters

NameType
keyKey
fetchernull | BareFetcher<Data>

Returns

SWRResponse<Data, Error, any>

Defined in

node_modules/swr/_internal/dist/index.d.ts:205

useSWR<Data, Error, SWROptions>(key, config): SWRResponse<Data, Error, SWROptions>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
const { data, error } = useSWR('/api/user', fetcher)
if (error) return <div>failed to load</div>
if (!data) return <div>loading...</div>
return <div>hello {data.name}!</div>
}

Type parameters

NameType
Dataany
Errorany
SWROptionsextends undefined | Partial<PublicConfiguration<Data, Error, BareFetcher<Data>>> = undefined | Partial<PublicConfiguration<Data, Error, BareFetcher<Data>>>

Parameters

NameType
keyKey
configSWROptions

Returns

SWRResponse<Data, Error, SWROptions>

Defined in

node_modules/swr/_internal/dist/index.d.ts:206

useSWR<Data, Error, SWROptions>(key, fetcher, config): SWRResponse<Data, Error, SWROptions>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
const { data, error } = useSWR('/api/user', fetcher)
if (error) return <div>failed to load</div>
if (!data) return <div>loading...</div>
return <div>hello {data.name}!</div>
}

Type parameters

NameType
Dataany
Errorany
SWROptionsextends undefined | Partial<PublicConfiguration<Data, Error, BareFetcher<Data>>> = undefined | Partial<PublicConfiguration<Data, Error, BareFetcher<Data>>>

Parameters

NameType
keyKey
fetchernull | BareFetcher<Data>
configSWROptions

Returns

SWRResponse<Data, Error, SWROptions>

Defined in

node_modules/swr/_internal/dist/index.d.ts:207


useSWRConfig

useSWRConfig(): FullConfiguration<any, any, BareFetcher<unknown>>

Returns

FullConfiguration<any, any, BareFetcher<unknown>>

Defined in

node_modules/swr/_internal/dist/index.d.ts:336


useSettings

useSettings(): Partial<SettingsContextProps>

Returns

Partial<SettingsContextProps>

Defined in

packages/core/src/react/provider/useSettings.ts:4


useThemeSetting

useThemeSetting(path, blockName?, defaultValue?, fallbackToGlobalSetting?): any

Returns a single theme setting normalized

Parameters

NameTypeDefault valueDescription
pathstringundefinedThe path to the setting
blockNamenull | string''The block name
defaultValueany''the default value to return
fallbackToGlobalSettingbooleantrueWhether it should fallback to global setting if blockName is passed but setting does not exist

Returns

any

Defined in

packages/core/src/react/provider/useThemeSetting.ts:22


useThemeSettings

useThemeSettings(): undefined | SettingsProperties & { blocks?: { core/archives?: SettingsPropertiesComplete ; core/audio?: SettingsPropertiesComplete ; core/block?: SettingsPropertiesComplete ; core/button?: SettingsPropertiesComplete ; core/buttons?: SettingsPropertiesComplete ; core/calendar?: SettingsPropertiesComplete ; core/categories?: SettingsPropertiesComplete ; core/code?: SettingsPropertiesComplete ; core/column?: SettingsPropertiesComplete ; core/columns?: SettingsPropertiesComplete ; core/comment-author-avatar?: SettingsPropertiesComplete ; core/comment-author-name?: SettingsPropertiesComplete ; core/comment-content?: SettingsPropertiesComplete ; core/comment-date?: SettingsPropertiesComplete ; core/comment-edit-link?: SettingsPropertiesComplete ; core/comment-reply-link?: SettingsPropertiesComplete ; core/comment-template?: SettingsPropertiesComplete ; core/comments-query-loop?: SettingsPropertiesComplete ; core/cover?: SettingsPropertiesComplete ; core/embed?: SettingsPropertiesComplete ; core/file?: SettingsPropertiesComplete ; core/freeform?: SettingsPropertiesComplete ; core/gallery?: SettingsPropertiesComplete ; core/group?: SettingsPropertiesComplete ; core/heading?: SettingsPropertiesComplete ; core/home-link?: SettingsPropertiesComplete ; core/html?: SettingsPropertiesComplete ; core/image?: SettingsPropertiesComplete ; core/latest-comments?: SettingsPropertiesComplete ; core/latest-posts?: SettingsPropertiesComplete ; core/legacy-widget?: SettingsPropertiesComplete ; core/list?: SettingsPropertiesComplete ; core/loginout?: SettingsPropertiesComplete ; core/media-text?: SettingsPropertiesComplete ; core/missing?: SettingsPropertiesComplete ; core/more?: SettingsPropertiesComplete ; core/navigation?: SettingsPropertiesComplete ; core/navigation-link?: SettingsPropertiesComplete ; core/nextpage?: SettingsPropertiesComplete ; core/page-list?: SettingsPropertiesComplete ; core/paragraph?: SettingsPropertiesComplete ; core/post-author?: SettingsPropertiesComplete ; core/post-comments?: SettingsPropertiesComplete ; core/post-comments-count?: SettingsPropertiesComplete ; core/post-comments-form?: SettingsPropertiesComplete ; core/post-comments-link?: SettingsPropertiesComplete ; core/post-content?: SettingsPropertiesComplete ; core/post-date?: SettingsPropertiesComplete ; core/post-excerpt?: SettingsPropertiesComplete ; core/post-featured-image?: SettingsPropertiesComplete ; core/post-navigation-link?: SettingsPropertiesComplete ; core/post-template?: SettingsPropertiesComplete ; core/post-terms?: SettingsPropertiesComplete ; core/post-title?: SettingsPropertiesComplete ; core/preformatted?: SettingsPropertiesComplete ; core/pullquote?: SettingsPropertiesComplete ; core/query?: SettingsPropertiesComplete ; core/query-pagination?: SettingsPropertiesComplete ; core/query-pagination-next?: SettingsPropertiesComplete ; core/query-pagination-numbers?: SettingsPropertiesComplete ; core/query-pagination-previous?: SettingsPropertiesComplete ; core/query-title?: SettingsPropertiesComplete ; core/quote?: SettingsPropertiesComplete ; core/rss?: SettingsPropertiesComplete ; core/search?: SettingsPropertiesComplete ; core/separator?: SettingsPropertiesComplete ; core/shortcode?: SettingsPropertiesComplete ; core/site-logo?: SettingsPropertiesComplete ; core/site-tagline?: SettingsPropertiesComplete ; core/site-title?: SettingsPropertiesComplete ; core/social-link?: SettingsPropertiesComplete ; core/social-links?: SettingsPropertiesComplete ; core/spacer?: SettingsPropertiesComplete ; core/table?: SettingsPropertiesComplete ; core/table-of-contents?: SettingsPropertiesComplete ; core/tag-cloud?: SettingsPropertiesComplete ; core/template-part?: SettingsPropertiesComplete ; core/term-description?: SettingsPropertiesComplete ; core/text-columns?: SettingsPropertiesComplete ; core/verse?: SettingsPropertiesComplete ; core/video?: SettingsPropertiesComplete ; core/widget-area?: SettingsPropertiesComplete ; core/widget-group?: SettingsPropertiesComplete } ; border?: { color?: boolean ; radius?: boolean ; style?: boolean ; width?: boolean } ; color?: { background?: boolean ; custom?: boolean ; customDuotone?: boolean ; customGradient?: boolean ; defaultGradients?: boolean ; defaultPalette?: boolean ; duotone?: SettingsDuotone ; gradients?: SettingsGradient ; link?: boolean ; palette?: SettingsColorPalette ; text?: boolean } ; custom?: { [k: string]: string | number | SettingsCustomAdditionalProperties; } ; layout?: { contentSize?: string ; wideSize?: string } ; spacing?: { blockGap?: null | boolean ; margin?: boolean ; padding?: boolean ; units?: string[] } ; typography?: { customFontSize?: boolean ; dropCap?: boolean ; fontFamilies?: { fontFamily?: string ; name?: string ; slug?: string }[] ; fontSizes?: { name?: string ; size?: string ; slug?: string }[] ; fontStyle?: boolean ; fontWeight?: boolean ; letterSpacing?: boolean ; lineHeight?: boolean ; textDecoration?: boolean ; textTransform?: boolean } }

Returns the raw theme.json settings definitions

Returns

undefined | SettingsProperties & { blocks?: { core/archives?: SettingsPropertiesComplete ; core/audio?: SettingsPropertiesComplete ; core/block?: SettingsPropertiesComplete ; core/button?: SettingsPropertiesComplete ; core/buttons?: SettingsPropertiesComplete ; core/calendar?: SettingsPropertiesComplete ; core/categories?: SettingsPropertiesComplete ; core/code?: SettingsPropertiesComplete ; core/column?: SettingsPropertiesComplete ; core/columns?: SettingsPropertiesComplete ; core/comment-author-avatar?: SettingsPropertiesComplete ; core/comment-author-name?: SettingsPropertiesComplete ; core/comment-content?: SettingsPropertiesComplete ; core/comment-date?: SettingsPropertiesComplete ; core/comment-edit-link?: SettingsPropertiesComplete ; core/comment-reply-link?: SettingsPropertiesComplete ; core/comment-template?: SettingsPropertiesComplete ; core/comments-query-loop?: SettingsPropertiesComplete ; core/cover?: SettingsPropertiesComplete ; core/embed?: SettingsPropertiesComplete ; core/file?: SettingsPropertiesComplete ; core/freeform?: SettingsPropertiesComplete ; core/gallery?: SettingsPropertiesComplete ; core/group?: SettingsPropertiesComplete ; core/heading?: SettingsPropertiesComplete ; core/home-link?: SettingsPropertiesComplete ; core/html?: SettingsPropertiesComplete ; core/image?: SettingsPropertiesComplete ; core/latest-comments?: SettingsPropertiesComplete ; core/latest-posts?: SettingsPropertiesComplete ; core/legacy-widget?: SettingsPropertiesComplete ; core/list?: SettingsPropertiesComplete ; core/loginout?: SettingsPropertiesComplete ; core/media-text?: SettingsPropertiesComplete ; core/missing?: SettingsPropertiesComplete ; core/more?: SettingsPropertiesComplete ; core/navigation?: SettingsPropertiesComplete ; core/navigation-link?: SettingsPropertiesComplete ; core/nextpage?: SettingsPropertiesComplete ; core/page-list?: SettingsPropertiesComplete ; core/paragraph?: SettingsPropertiesComplete ; core/post-author?: SettingsPropertiesComplete ; core/post-comments?: SettingsPropertiesComplete ; core/post-comments-count?: SettingsPropertiesComplete ; core/post-comments-form?: SettingsPropertiesComplete ; core/post-comments-link?: SettingsPropertiesComplete ; core/post-content?: SettingsPropertiesComplete ; core/post-date?: SettingsPropertiesComplete ; core/post-excerpt?: SettingsPropertiesComplete ; core/post-featured-image?: SettingsPropertiesComplete ; core/post-navigation-link?: SettingsPropertiesComplete ; core/post-template?: SettingsPropertiesComplete ; core/post-terms?: SettingsPropertiesComplete ; core/post-title?: SettingsPropertiesComplete ; core/preformatted?: SettingsPropertiesComplete ; core/pullquote?: SettingsPropertiesComplete ; core/query?: SettingsPropertiesComplete ; core/query-pagination?: SettingsPropertiesComplete ; core/query-pagination-next?: SettingsPropertiesComplete ; core/query-pagination-numbers?: SettingsPropertiesComplete ; core/query-pagination-previous?: SettingsPropertiesComplete ; core/query-title?: SettingsPropertiesComplete ; core/quote?: SettingsPropertiesComplete ; core/rss?: SettingsPropertiesComplete ; core/search?: SettingsPropertiesComplete ; core/separator?: SettingsPropertiesComplete ; core/shortcode?: SettingsPropertiesComplete ; core/site-logo?: SettingsPropertiesComplete ; core/site-tagline?: SettingsPropertiesComplete ; core/site-title?: SettingsPropertiesComplete ; core/social-link?: SettingsPropertiesComplete ; core/social-links?: SettingsPropertiesComplete ; core/spacer?: SettingsPropertiesComplete ; core/table?: SettingsPropertiesComplete ; core/table-of-contents?: SettingsPropertiesComplete ; core/tag-cloud?: SettingsPropertiesComplete ; core/template-part?: SettingsPropertiesComplete ; core/term-description?: SettingsPropertiesComplete ; core/text-columns?: SettingsPropertiesComplete ; core/verse?: SettingsPropertiesComplete ; core/video?: SettingsPropertiesComplete ; core/widget-area?: SettingsPropertiesComplete ; core/widget-group?: SettingsPropertiesComplete } ; border?: { color?: boolean ; radius?: boolean ; style?: boolean ; width?: boolean } ; color?: { background?: boolean ; custom?: boolean ; customDuotone?: boolean ; customGradient?: boolean ; defaultGradients?: boolean ; defaultPalette?: boolean ; duotone?: SettingsDuotone ; gradients?: SettingsGradient ; link?: boolean ; palette?: SettingsColorPalette ; text?: boolean } ; custom?: { [k: string]: string | number | SettingsCustomAdditionalProperties; } ; layout?: { contentSize?: string ; wideSize?: string } ; spacing?: { blockGap?: null | boolean ; margin?: boolean ; padding?: boolean ; units?: string[] } ; typography?: { customFontSize?: boolean ; dropCap?: boolean ; fontFamilies?: { fontFamily?: string ; name?: string ; slug?: string }[] ; fontSizes?: { name?: string ; size?: string ; slug?: string }[] ; fontStyle?: boolean ; fontWeight?: boolean ; letterSpacing?: boolean ; lineHeight?: boolean ; textDecoration?: boolean ; textTransform?: boolean } }

Defined in

packages/core/src/react/provider/useThemeSettings.ts:9


useThemeStyles

useThemeStyles(): undefined | StylesProperties & { blocks?: { core/archives?: StylesPropertiesAndElementsComplete ; core/audio?: StylesPropertiesAndElementsComplete ; core/block?: StylesPropertiesAndElementsComplete ; core/button?: StylesPropertiesAndElementsComplete ; core/buttons?: StylesPropertiesAndElementsComplete ; core/calendar?: StylesPropertiesAndElementsComplete ; core/categories?: StylesPropertiesAndElementsComplete ; core/code?: StylesPropertiesAndElementsComplete ; core/column?: StylesPropertiesAndElementsComplete ; core/columns?: StylesPropertiesAndElementsComplete ; core/comment-author-avatar?: StylesPropertiesAndElementsComplete ; core/comment-author-name?: StylesPropertiesAndElementsComplete ; core/comment-content?: StylesPropertiesAndElementsComplete ; core/comment-date?: StylesPropertiesAndElementsComplete ; core/comment-edit-link?: StylesPropertiesAndElementsComplete ; core/comment-reply-link?: StylesPropertiesAndElementsComplete ; core/comment-template?: StylesPropertiesAndElementsComplete ; core/comments-query-loop?: StylesPropertiesAndElementsComplete ; core/cover?: StylesPropertiesAndElementsComplete ; core/embed?: StylesPropertiesAndElementsComplete ; core/file?: StylesPropertiesAndElementsComplete ; core/freeform?: StylesPropertiesAndElementsComplete ; core/gallery?: StylesPropertiesAndElementsComplete ; core/group?: StylesPropertiesAndElementsComplete ; core/heading?: StylesPropertiesAndElementsComplete ; core/home-link?: StylesPropertiesAndElementsComplete ; core/html?: StylesPropertiesAndElementsComplete ; core/image?: StylesPropertiesAndElementsComplete ; core/latest-comments?: StylesPropertiesAndElementsComplete ; core/latest-posts?: StylesPropertiesAndElementsComplete ; core/legacy-widget?: StylesPropertiesAndElementsComplete ; core/list?: StylesPropertiesAndElementsComplete ; core/loginout?: StylesPropertiesAndElementsComplete ; core/media-text?: StylesPropertiesAndElementsComplete ; core/missing?: StylesPropertiesAndElementsComplete ; core/more?: StylesPropertiesAndElementsComplete ; core/navigation?: StylesPropertiesAndElementsComplete ; core/navigation-link?: StylesPropertiesAndElementsComplete ; core/nextpage?: StylesPropertiesAndElementsComplete ; core/page-list?: StylesPropertiesAndElementsComplete ; core/paragraph?: StylesPropertiesAndElementsComplete ; core/post-author?: StylesPropertiesAndElementsComplete ; core/post-comments?: StylesPropertiesAndElementsComplete ; core/post-comments-count?: StylesPropertiesAndElementsComplete ; core/post-comments-form?: StylesPropertiesAndElementsComplete ; core/post-comments-link?: StylesPropertiesAndElementsComplete ; core/post-content?: StylesPropertiesAndElementsComplete ; core/post-date?: StylesPropertiesAndElementsComplete ; core/post-excerpt?: StylesPropertiesAndElementsComplete ; core/post-featured-image?: StylesPropertiesAndElementsComplete ; core/post-navigation-link?: StylesPropertiesAndElementsComplete ; core/post-template?: StylesPropertiesAndElementsComplete ; core/post-terms?: StylesPropertiesAndElementsComplete ; core/post-title?: StylesPropertiesAndElementsComplete ; core/preformatted?: StylesPropertiesAndElementsComplete ; core/pullquote?: StylesPropertiesAndElementsComplete ; core/query?: StylesPropertiesAndElementsComplete ; core/query-pagination?: StylesPropertiesAndElementsComplete ; core/query-pagination-next?: StylesPropertiesAndElementsComplete ; core/query-pagination-numbers?: StylesPropertiesAndElementsComplete ; core/query-pagination-previous?: StylesPropertiesAndElementsComplete ; core/query-title?: StylesPropertiesAndElementsComplete ; core/quote?: StylesPropertiesAndElementsComplete ; core/rss?: StylesPropertiesAndElementsComplete ; core/search?: StylesPropertiesAndElementsComplete ; core/separator?: StylesPropertiesAndElementsComplete ; core/shortcode?: StylesPropertiesAndElementsComplete ; core/site-logo?: StylesPropertiesAndElementsComplete ; core/site-tagline?: StylesPropertiesAndElementsComplete ; core/site-title?: StylesPropertiesAndElementsComplete ; core/social-link?: StylesPropertiesAndElementsComplete ; core/social-links?: StylesPropertiesAndElementsComplete ; core/spacer?: StylesPropertiesAndElementsComplete ; core/table?: StylesPropertiesAndElementsComplete ; core/table-of-contents?: StylesPropertiesAndElementsComplete ; core/tag-cloud?: StylesPropertiesAndElementsComplete ; core/template-part?: StylesPropertiesAndElementsComplete ; core/term-description?: StylesPropertiesAndElementsComplete ; core/text-columns?: StylesPropertiesAndElementsComplete ; core/verse?: StylesPropertiesAndElementsComplete ; core/video?: StylesPropertiesAndElementsComplete ; core/widget-area?: StylesPropertiesAndElementsComplete ; core/widget-group?: StylesPropertiesAndElementsComplete } ; border?: unknown ; color?: unknown ; elements?: { h1?: StylesPropertiesComplete ; h2?: StylesPropertiesComplete ; h3?: StylesPropertiesComplete ; h4?: StylesPropertiesComplete ; h5?: StylesPropertiesComplete ; h6?: StylesPropertiesComplete ; link?: StylesPropertiesComplete } ; spacing?: unknown ; typography?: unknown }

Returns the theme.json styles definitions

Returns

undefined | StylesProperties & { blocks?: { core/archives?: StylesPropertiesAndElementsComplete ; core/audio?: StylesPropertiesAndElementsComplete ; core/block?: StylesPropertiesAndElementsComplete ; core/button?: StylesPropertiesAndElementsComplete ; core/buttons?: StylesPropertiesAndElementsComplete ; core/calendar?: StylesPropertiesAndElementsComplete ; core/categories?: StylesPropertiesAndElementsComplete ; core/code?: StylesPropertiesAndElementsComplete ; core/column?: StylesPropertiesAndElementsComplete ; core/columns?: StylesPropertiesAndElementsComplete ; core/comment-author-avatar?: StylesPropertiesAndElementsComplete ; core/comment-author-name?: StylesPropertiesAndElementsComplete ; core/comment-content?: StylesPropertiesAndElementsComplete ; core/comment-date?: StylesPropertiesAndElementsComplete ; core/comment-edit-link?: StylesPropertiesAndElementsComplete ; core/comment-reply-link?: StylesPropertiesAndElementsComplete ; core/comment-template?: StylesPropertiesAndElementsComplete ; core/comments-query-loop?: StylesPropertiesAndElementsComplete ; core/cover?: StylesPropertiesAndElementsComplete ; core/embed?: StylesPropertiesAndElementsComplete ; core/file?: StylesPropertiesAndElementsComplete ; core/freeform?: StylesPropertiesAndElementsComplete ; core/gallery?: StylesPropertiesAndElementsComplete ; core/group?: StylesPropertiesAndElementsComplete ; core/heading?: StylesPropertiesAndElementsComplete ; core/home-link?: StylesPropertiesAndElementsComplete ; core/html?: StylesPropertiesAndElementsComplete ; core/image?: StylesPropertiesAndElementsComplete ; core/latest-comments?: StylesPropertiesAndElementsComplete ; core/latest-posts?: StylesPropertiesAndElementsComplete ; core/legacy-widget?: StylesPropertiesAndElementsComplete ; core/list?: StylesPropertiesAndElementsComplete ; core/loginout?: StylesPropertiesAndElementsComplete ; core/media-text?: StylesPropertiesAndElementsComplete ; core/missing?: StylesPropertiesAndElementsComplete ; core/more?: StylesPropertiesAndElementsComplete ; core/navigation?: StylesPropertiesAndElementsComplete ; core/navigation-link?: StylesPropertiesAndElementsComplete ; core/nextpage?: StylesPropertiesAndElementsComplete ; core/page-list?: StylesPropertiesAndElementsComplete ; core/paragraph?: StylesPropertiesAndElementsComplete ; core/post-author?: StylesPropertiesAndElementsComplete ; core/post-comments?: StylesPropertiesAndElementsComplete ; core/post-comments-count?: StylesPropertiesAndElementsComplete ; core/post-comments-form?: StylesPropertiesAndElementsComplete ; core/post-comments-link?: StylesPropertiesAndElementsComplete ; core/post-content?: StylesPropertiesAndElementsComplete ; core/post-date?: StylesPropertiesAndElementsComplete ; core/post-excerpt?: StylesPropertiesAndElementsComplete ; core/post-featured-image?: StylesPropertiesAndElementsComplete ; core/post-navigation-link?: StylesPropertiesAndElementsComplete ; core/post-template?: StylesPropertiesAndElementsComplete ; core/post-terms?: StylesPropertiesAndElementsComplete ; core/post-title?: StylesPropertiesAndElementsComplete ; core/preformatted?: StylesPropertiesAndElementsComplete ; core/pullquote?: StylesPropertiesAndElementsComplete ; core/query?: StylesPropertiesAndElementsComplete ; core/query-pagination?: StylesPropertiesAndElementsComplete ; core/query-pagination-next?: StylesPropertiesAndElementsComplete ; core/query-pagination-numbers?: StylesPropertiesAndElementsComplete ; core/query-pagination-previous?: StylesPropertiesAndElementsComplete ; core/query-title?: StylesPropertiesAndElementsComplete ; core/quote?: StylesPropertiesAndElementsComplete ; core/rss?: StylesPropertiesAndElementsComplete ; core/search?: StylesPropertiesAndElementsComplete ; core/separator?: StylesPropertiesAndElementsComplete ; core/shortcode?: StylesPropertiesAndElementsComplete ; core/site-logo?: StylesPropertiesAndElementsComplete ; core/site-tagline?: StylesPropertiesAndElementsComplete ; core/site-title?: StylesPropertiesAndElementsComplete ; core/social-link?: StylesPropertiesAndElementsComplete ; core/social-links?: StylesPropertiesAndElementsComplete ; core/spacer?: StylesPropertiesAndElementsComplete ; core/table?: StylesPropertiesAndElementsComplete ; core/table-of-contents?: StylesPropertiesAndElementsComplete ; core/tag-cloud?: StylesPropertiesAndElementsComplete ; core/template-part?: StylesPropertiesAndElementsComplete ; core/term-description?: StylesPropertiesAndElementsComplete ; core/text-columns?: StylesPropertiesAndElementsComplete ; core/verse?: StylesPropertiesAndElementsComplete ; core/video?: StylesPropertiesAndElementsComplete ; core/widget-area?: StylesPropertiesAndElementsComplete ; core/widget-group?: StylesPropertiesAndElementsComplete } ; border?: unknown ; color?: unknown ; elements?: { h1?: StylesPropertiesComplete ; h2?: StylesPropertiesComplete ; h3?: StylesPropertiesComplete ; h4?: StylesPropertiesComplete ; h5?: StylesPropertiesComplete ; h6?: StylesPropertiesComplete ; link?: StylesPropertiesComplete } ; spacing?: unknown ; typography?: unknown }

Defined in

packages/core/src/react/provider/useThemeStyles.ts:9

React Components

BlocksRenderer

BlocksRenderer(props): Element

The BlocksRenderer components provides an easy way to convert HTML markup into corresponding +the actual data fetching logic

Type parameters

NameType
EE
Paramsextends EndpointParams
RE

Parameters

NameTypeDefault valueDescription
params{} | ParamsundefinedThe list of params to pass to the fetch strategy. It overrides the ones in the URL.
fetchStrategyAbstractFetchStrategy<E, Params, R>undefinedThe fetch strategy.
optionsFetchHookOptions<FetchResponse<R>>{}The options to pass to the swr hook.
pathstring''The path of the url to get url params from.

Returns

Object

NameTypeDescription
dataundefined | FetchResponse<R>The returned data of the fetcher function.
erroranyThe error object thrown by the fetcher function.
isLoadingboolean-
isMainQueryboolean-
isValidatingboolean-
mutateKeyedMutator<FetchResponse<R>>-
paramsPartial<Params>-

Defined in

packages/core/src/react/hooks/useFetch.ts:30


useFetchAppSettings

useFetchAppSettings<T, P>(params?, options?): useAppSettingsResponse<T>

The useAppSettings hook

See useAppSettings

Type parameters

NameType
Textends AppEntity = AppEntity
Pextends EndpointParams = EndpointParams

Parameters

NameTypeDescription
params{} | PThe list of params to pass to the fetch strategy. It overrides the ones in the URL.
optionsFetchHookOptions<FetchResponse<T>>The options to pass to the swr hook.

Returns

useAppSettingsResponse<T>

Defined in

packages/core/src/react/hooks/useFetchAppSettings.ts:21


useFetchMenu

useFetchMenu(menuLocation, options?): useMenuResponse

The useFetchMenu hooks. Returns a Menu object.

Parameters

NameTypeDescription
menuLocationstringThe slug of the menu location you want to fetch
optionsFetchHookOptions<FetchResponse<AppEntity>>SWR configuration options

Returns

useMenuResponse

Defined in

packages/core/src/react/hooks/useFetchMenu.ts:50


useFetchPosts

useFetchPosts<T, P>(params?, options?, path?, fetcher?): usePostsResponse<T>

The useFetchPosts hook. Returns a collection of post entities

See usePosts for usage instructions.

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters

NameTypeDefault valueDescription
params{} | P{}The list of params to pass to the fetch strategy. It overrides the ones in the URL.
optionsFetchHookOptions<FetchResponse<T[]>>{}The options to pass to the swr hook.
pathstring''The path of the url to get url params from.
fetcherundefined | PostsArchiveFetchStrategy<T, P>undefinedThe fetch strategy to use. If none is passed, the default one is used

Returns

usePostsResponse<T>

Defined in

packages/core/src/react/hooks/useFetchPosts.ts:79


useFetchSearch

useFetchSearch<T, P>(params?, options?, path?): useSearchResponse<T>

The useFetchSearch hook. Returns a collection of post entities

See useSearch for usage instructions.

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters

NameTypeDefault valueDescription
params{} | P{}The list of params to pass to the fetch strategy. It overrides the ones in the URL.
optionsFetchHookOptions<FetchResponse<T[]>>{}The options to pass to the swr hook.
pathstring''The path of the url to get url params from.

Returns

useSearchResponse<T>

Defined in

packages/core/src/react/hooks/useFetchSearch.ts:32


useFetchTerms

useFetchTerms<T, P>(params, options?, path?): useTermsResponse<T>

The useFetchTerms hook. Returns a collection of term entities

See useTerms for usage instructions.

Type parameters

NameType
Textends TermEntity = TermEntity
Pextends TaxonomyArchiveParams = TaxonomyArchiveParams

Parameters

NameTypeDefault valueDescription
params{} | PundefinedThe list of params to pass to the fetch strategy. It overrides the ones in the URL.
optionsFetchHookOptions<FetchResponse<T[]>>{}The options to pass to the swr hook.
pathstring''The path of the url to get url params from.

Returns

useTermsResponse<T>

Defined in

packages/core/src/react/hooks/useFetchTerms.ts:29

Other

Align

Ƭ Align: "none" | "left" | "center" | "right" | "wide" | "full"

Defined in

packages/core/src/react/blocks/types.ts:15


Border

Ƭ Border: Object

Type declaration

NameType
radius?string
style?string
width?string

Defined in

packages/core/src/react/blocks/types.ts:65


DataFetchingProviderProps

Ƭ DataFetchingProviderProps: Object

Type declaration

NameTypeDescription
dataSWRConfiguration["fallback"]-
swrConfigSWRConfigurationPass any configuration to the SWR library. Globally. These settings can be overridden at the hook level.

Defined in

packages/core/src/react/provider/DataFetchingProvider.tsx:6


ItemWrapper

Ƭ ItemWrapper: (props: ItemWrapperProps) => JSX.Element

Type declaration

▸ (props): JSX.Element

Parameters
NameType
propsItemWrapperProps
Returns

JSX.Element

Defined in

packages/core/src/react/components/Menu.tsx:15


ItemWrapperProps

Ƭ ItemWrapperProps: PropsWithChildren<{ className: string ; depth: number ; item: MenuItemEntity }>

Defined in

packages/core/src/react/components/Menu.tsx:10


Ƭ LinkWrapper: (props: LinkWrapperProps) => JSX.Element

Type declaration

▸ (props): JSX.Element

Parameters
NameType
propsLinkWrapperProps
Returns

JSX.Element

Defined in

packages/core/src/react/components/Menu.tsx:27


LinkWrapperProps

Ƭ LinkWrapperProps: PropsWithChildren<{ depth: number ; href: string }>

Defined in

packages/core/src/react/components/Menu.tsx:23


Ƭ MenuItemsProp: Object

Type declaration

NameType
depthnumber
itemWrapperItemWrapper
itemsMenuItemEntity[]
linkWrapperLinkWrapper
menuWrapperMenuWrapper
topLevelItemsClickableboolean

Defined in

packages/core/src/react/components/Menu.tsx:29


Ƭ MenuWrapper: (props: MenuWrapperProps) => JSX.Element

Type declaration

▸ (props): JSX.Element

Parameters
NameType
propsMenuWrapperProps
Returns

JSX.Element

Defined in

packages/core/src/react/components/Menu.tsx:21


Ƭ MenuWrapperProps: PropsWithChildren<{ className: string ; depth: number }>

Defined in

packages/core/src/react/components/Menu.tsx:17


PageType

Ƭ PageType: Object

Type declaration

NameTypeDescription
isAuthorArchivebooleanAuthor Archive
isCategoryArchivebooleanCategory Archive
isPostArchivebooleanRegular post archive
isPostTypeArchivebooleanCustom Post Type Archive
isSearchbooleanSearch route
isTagArchivebooleanTag Archive
isTaxonomyArchivebooleanCustom Taxonomy Archive
postTypestringWhich post type this archive is for
taxonomystringWhich taxonomy this archive is for

Defined in

packages/core/src/react/hooks/useFetchPosts.ts:19


SettingsColorPalette

Ƭ SettingsColorPalette: Object

Type declaration

NameType
default?SettingsColorPreset[]
theme?SettingsColorPreset[]
user?SettingsColorPreset[]

Defined in

packages/core/src/react/provider/types.ts:47


SettingsColorPreset

Ƭ SettingsColorPreset: Object

Type declaration

NameTypeDescription
colorstringCSS hex or rgb(a) string.
namestringName of the color preset, translatable.
slugstringKebab-case unique identifier for the color preset.

Defined in

packages/core/src/react/provider/types.ts:32


SettingsContextProps

Ƭ SettingsContextProps: { imageComponent?: React.FC<IImageBlock> ; linkComponent?: ReactNode } & HeadlessConfig

Defined in

packages/core/src/react/provider/types.ts:5


SettingsDuotone

Ƭ SettingsDuotone: Object

Type declaration

NameType
default?SettingsDuotonePreset[]
theme?SettingsDuotonePreset[]
user?SettingsDuotonePreset[]

Defined in

packages/core/src/react/provider/types.ts:89


SettingsDuotonePreset

Ƭ SettingsDuotonePreset: Object

Type declaration

NameTypeDescription
colorsstring[]List of colors from dark to light.
namestringName of the duotone preset, translatable.
slugstringKebab-case unique identifier for the duotone preset.

Defined in

packages/core/src/react/provider/types.ts:74


SettingsGradient

Ƭ SettingsGradient: Object

Type declaration

NameType
default?SettingsGradientPreset[]
theme?SettingsGradientPreset[]
user?SettingsGradientPreset[]

Defined in

packages/core/src/react/provider/types.ts:68


SettingsGradientPreset

Ƭ SettingsGradientPreset: Object

Type declaration

NameTypeDescription
gradientstringCSS gradient string.
namestringName of the gradient preset, translatable.
slugstringKebab-case unique identifier for the gradient preset.

Defined in

packages/core/src/react/provider/types.ts:53


SettingsPropertiesComplete

Ƭ SettingsPropertiesComplete: SettingsProperties & { border?: SettingsProperties["border"] ; color?: SettingsProperties["color"] ; custom?: SettingsProperties["custom"] ; layout?: SettingsProperties["layout"] ; spacing?: SettingsProperties["spacing"] ; typography?: SettingsProperties["typography"] }

Defined in

packages/core/src/react/provider/types.ts:10


Spacing

Ƭ Spacing: Object

Type declaration

NameType
blockGapstring
margin{ bottom: string ; left: string ; right: string ; top: string }
margin.bottomstring
margin.leftstring
margin.rightstring
margin.topstring
padding{ bottom: string ; left: string ; right: string ; top: string }
padding.bottomstring
padding.leftstring
padding.rightstring
padding.topstring
supportsBlockGapboolean
supportsMarginboolean
supportsPaddingboolean

Defined in

packages/core/src/react/blocks/types.ts:40


Style

Ƭ Style: Object

Type declaration

NameType
borderBorder
spacingSpacing
typographyTypography

Defined in

packages/core/src/react/blocks/types.ts:17


StylesPropertiesAndElementsComplete

Ƭ StylesPropertiesAndElementsComplete: StylesProperties & { border?: SettingsProperties["border"] ; color?: SettingsProperties["color"] ; elements?: StylesElementsPropertiesComplete ; spacing?: SettingsProperties["spacing"] ; typography?: SettingsProperties["typography"] }

Defined in

packages/core/src/react/provider/types.ts:24


StylesPropertiesComplete

Ƭ StylesPropertiesComplete: StylesProperties & { border?: SettingsProperties["border"] ; color?: SettingsProperties["color"] ; spacing?: SettingsProperties["spacing"] ; typography?: SettingsProperties["typography"] }

Defined in

packages/core/src/react/provider/types.ts:18


ThemeJSON

Ƭ ThemeJSON: Pick<WpThemeJSON, "styles" | "settings">

Defined in

packages/core/src/react/provider/types.ts:352


SettingsContext

Const SettingsContext: Context<Partial<SettingsContextProps>>

Defined in

packages/core/src/react/provider/Provider.tsx:5


ThemeSettingsContext

Const ThemeSettingsContext: Context<ThemeJSON>

Defined in

packages/core/src/react/provider/ThemeSettingsProvider.tsx:4


defaultElement

Const defaultElement: Element

Defined in

packages/core/src/react/blocks/hooks/useBlock.ts:8


ColumnBlock

ColumnBlock(«destructured»): Element

Parameters

NameType
«destructured»IColumnBlock

Returns

Element

Defined in

packages/core/src/react/blocks/ColumnBlock.tsx:11


ColumnsBlock

ColumnsBlock(«destructured»): Element

Parameters

NameType
«destructured»IColumnsBlock

Returns

Element

Defined in

packages/core/src/react/blocks/ColumnsBlocks.tsx:11


CoverBlock

CoverBlock(«destructured»): Element

Parameters

NameType
«destructured»ICoverBlock

Returns

Element

Defined in

packages/core/src/react/blocks/CoverBlock.tsx:24


DataFetchingProvider

DataFetchingProvider(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<DataFetchingProviderProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/@types/react/index.d.ts:542


DebugBlock

DebugBlock(«destructured»): Element

Parameters

NameType
«destructured»Object

Returns

Element

Defined in

packages/core/src/react/blocks/DebugBlock.tsx:7


FileBlock

FileBlock(«destructured»): Element

Parameters

NameType
«destructured»IFileBlock

Returns

Element

Defined in

packages/core/src/react/blocks/FileBlock.tsx:14


GroupBlock

GroupBlock(«destructured»): Element

Parameters

NameType
«destructured»IGroupBlock

Returns

Element

Defined in

packages/core/src/react/blocks/GroupBlock.tsx:17


HeadingBlock

HeadingBlock(«destructured»): Element

Parameters

NameType
«destructured»IHeadingBlock

Returns

Element

Defined in

packages/core/src/react/blocks/HeadingBlock.tsx:12


ImageBlock

ImageBlock(«destructured»): Element

Parameters

NameType
«destructured»IImageBlock

Returns

Element

Defined in

packages/core/src/react/blocks/ImageBlock.tsx:19


ListBlock

ListBlock(«destructured»): Element

Parameters

NameType
«destructured»IListBlock

Returns

Element

Defined in

packages/core/src/react/blocks/ListBlock.tsx:12


MediaTextBlock

MediaTextBlock(«destructured»): Element

Parameters

NameType
«destructured»IMediaTextBlock

Returns

Element

Defined in

packages/core/src/react/blocks/MediaTextBlock.tsx:22


Menu(«destructured»): Element

Parameters

NameType
«destructured»MenuProps

Returns

Element

Defined in

packages/core/src/react/components/Menu.tsx:109


MenuItems(«destructured»): Element

Parameters

NameType
«destructured»MenuItemsProp

Returns

Element

Defined in

packages/core/src/react/components/Menu.tsx:54


ParagraphBlock

ParagraphBlock(«destructured»): Element

Parameters

NameType
«destructured»IParagraphBlock

Returns

Element

Defined in

packages/core/src/react/blocks/ParagraphBlock.tsx:13


PreformattedBlock

PreformattedBlock(«destructured»): Element

Parameters

NameType
«destructured»IPreformattedBlock

Returns

Element

Defined in

packages/core/src/react/blocks/PreformatedBlock.tsx:11


PullQuoteBlock

PullQuoteBlock(«destructured»): Element

Parameters

NameType
«destructured»IPullQuoteBlock

Returns

Element

Defined in

packages/core/src/react/blocks/PullQuote.tsx:15


QuoteBlock

QuoteBlock(«destructured»): Element

Parameters

NameType
«destructured»IQuoteBlock

Returns

Element

Defined in

packages/core/src/react/blocks/QuoteBlock.tsx:10


SeparatorBlock

SeparatorBlock(«destructured»): Element

Parameters

NameType
«destructured»ISeparatorBlock

Returns

Element

Defined in

packages/core/src/react/blocks/SeparatorBlock.tsx:10


SettingsProvider

SettingsProvider(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<ProviderProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/@types/react/index.d.ts:542


SpacerBlock

SpacerBlock(«destructured»): Element

Parameters

NameType
«destructured»ISpacerBlock

Returns

Element

Defined in

packages/core/src/react/blocks/SpacerBlock.tsx:12


TableBlock

TableBlock(«destructured»): Element

Parameters

NameType
«destructured»ITableBlock

Returns

Element

Defined in

packages/core/src/react/blocks/TableBlock.tsx:12


ThemeSettingsProvider

ThemeSettingsProvider(props, context?): null | ReactElement<any, any>

Parameters

NameType
propsPropsWithChildren<ProviderProps>
context?any

Returns

null | ReactElement<any, any>

Defined in

node_modules/@types/react/index.d.ts:542


VerseBlock

VerseBlock(«destructured»): Element

Parameters

NameType
«destructured»IVerseBlock

Returns

Element

Defined in

packages/core/src/react/blocks/VerseBlock.tsx:11


YoutubeLiteBlock

YoutubeLiteBlock(props): Element

Renders Youtube embeds with lite-youtube-embed

Parameters

NameTypeDescription
propsOmit<IYoutubeLiteBlock, "component">The Block props

Returns

Element

Defined in

packages/core/src/react/blocks/YoutubeLiteBlock.tsx:41


getAlignStyle

getAlignStyle(domNode): "none" | "left" | "center" | "right" | "wide" | "full"

Parameters

NameType
domNodeElement

Returns

"none" | "left" | "center" | "right" | "wide" | "full"

Defined in

packages/core/src/react/blocks/utils.ts:5


getBlockStyle

getBlockStyle(domNode): string

Returns the block style (is-style-{block-style})

Parameters

NameTypeDescription
domNodeElementDomNode

Returns

string

string with block style

Defined in

packages/core/src/react/blocks/utils.ts:39


getColorStyles

getColorStyles(domNode): Colors

Infer GB color styles from classnames

Parameters

NameTypeDescription
domNodeElementDomNode

Returns

Colors

ColorBlockProps object

Defined in

packages/core/src/react/blocks/utils.ts:62


getInlineStyles

getInlineStyles(domNode): false | Record<string, string>

Converts inline styles to a stylesObject for use in react components

Parameters

NameTypeDescription
domNodeElementDomNode

Returns

false | Record<string, string>

Defined in

packages/core/src/react/blocks/utils.ts:120


getTypographyStyles

getTypographyStyles(domNode): Object

Returns the typography styles of a block

Parameters

NameTypeDescription
domNodeElementDomNode

Returns

Object

NameType
fontSizestring
style{ fontSize: string = ''; lineHeight: string = '' }
style.fontSizestring
style.lineHeightstring

Defined in

packages/core/src/react/blocks/utils.ts:177


getWidthStyles

getWidthStyles(domNode): undefined | string

Returns the width size of a block

Parameters

NameTypeDescription
domNodeElementDomNode

Returns

undefined | string

Defined in

packages/core/src/react/blocks/utils.ts:149


parseSeo

parseSeo(seo, options?): string | Element | Element[]

Parameters

NameType
seostring
optionsHTMLReactParserOptions

Returns

string | Element | Element[]

Defined in

packages/core/src/react/utils/parseSeo.ts:4


safeArraySpread

safeArraySpread(array): any[]

Parameters

NameType
arrayany

Returns

any[]

Defined in

packages/core/src/react/blocks/utils.ts:220


serializeKey

serializeKey(key): string

Parameters

NameType
keyKey

Returns

string

Defined in

node_modules/swr/core/dist/index.d.ts:17


useBlock

useBlock<T>(node?): Object

Returns the block name and attributes

Type parameters

NameType
Textends IBlockAttributes

Parameters

NameTypeDescription
node?ElementDomNode

Returns

Object

NameType
attributesT
classNamestring
namestring

Defined in

packages/core/src/react/blocks/hooks/useBlock.ts:38


useBlockAlign

useBlockAlign(node): Align

Returns the block align style (if available)

Parameters

NameTypeDescription
nodeElementDomNode

Returns

Align

Defined in

packages/core/src/react/blocks/hooks/useBlockAlign.ts:16


useBlockAttributes

useBlockAttributes(node?): Object

useBlockAttributes hooks returns the block attributes for a given block based on what it supports

Parameters

NameTypeDescription
node?ElementThe reference to the dom node of the block

Returns

Object

NameType
alignAlign
blockStylestring
borderBorder
colorsColors
spacingSpacing
typographyTypography
widthundefined | string

Defined in

packages/core/src/react/blocks/hooks/useBlockAttributes.ts:19


useBlockBorder

useBlockBorder(node): Border

Returns the block style (if available)

Parameters

NameTypeDescription
nodeElementDomNode

Returns

Border

Defined in

packages/core/src/react/blocks/hooks/useBlockBorder.ts:17


useBlockColors

useBlockColors(node): Colors

Returns the block style (if available)

Parameters

NameTypeDescription
nodeElementDomNode

Returns

Colors

Defined in

packages/core/src/react/blocks/hooks/useBlockColors.ts:25


useBlockSpacing

useBlockSpacing(node): Spacing

Returns the block style (if available)

Parameters

NameTypeDescription
nodeElementDomNode

Returns

Spacing

Defined in

packages/core/src/react/blocks/hooks/useBlockSpacing.ts:21


useBlockStyle

useBlockStyle(node): string

Returns the block style (if available)

Parameters

NameTypeDescription
nodeElementDomNode

Returns

string

Defined in

packages/core/src/react/blocks/hooks/useBlockStyle.ts:10


useBlockTypography

useBlockTypography(node): Typography

Returns the block style (if available)

Parameters

NameTypeDescription
nodeElementDomNode

Returns

Typography

Defined in

packages/core/src/react/blocks/hooks/useBlockTypography.ts:25


useBlockWidth

useBlockWidth(node): undefined | string

Returns the block style (if available)

Parameters

NameTypeDescription
nodeElementDomNode

Returns

undefined | string

Defined in

packages/core/src/react/blocks/hooks/useBlockWidth.ts:16


useFetchAuthorArchive

useFetchAuthorArchive<T, P>(params?, options?, path?): usePostsResponse<T>

The useFetchAuthorArchive hook

See useAuthorArchive

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters

NameTypeDefault valueDescription
params{} | PostEntity{}The list of params to pass to the fetch strategy. It overrides the ones in the URL.
optionsFetchHookOptions<FetchResponse<T[]>>{}The options to pass to the swr hook.
pathstring''The path of the url to get url params from.

Returns

usePostsResponse<T>

Defined in

packages/core/src/react/hooks/useFetchAuthorArchive.ts:22


useFetchPost

useFetchPost<T, P>(params?, options?, path?): usePostResponse<T>

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostParams = PostParams

Parameters

NameTypeDefault value
params{} | P{}
optionsFetchHookOptions<FetchResponse<T>>{}
pathstring''

Returns

usePostResponse<T>

Defined in

packages/core/src/react/hooks/useFetchPost.ts:30


useFetchPostOrPosts

useFetchPostOrPosts<T, P>(params?, options?, path?): usePostOrPostResponse<T>

Type parameters

NameType
Textends PostEntity = PostEntity
Pextends PostOrPostsParams = PostOrPostsParams

Parameters

NameTypeDefault value
paramsPartial<P>{}
optionsFetchHookOptions<FetchResponse<PostOrPostsFetchStrategyResult<T>>>{}
pathstring''

Returns

usePostOrPostResponse<T>

Defined in

packages/core/src/react/hooks/useFetchPostOrPosts.ts:32


useSWR

useSWR<Data, Error, SWRKey>(key): SWRResponse<Data, Error, any>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
const { data, error } = useSWR('/api/user', fetcher)
if (error) return <div>failed to load</div>
if (!data) return <div>loading...</div>
return <div>hello {data.name}!</div>
}

Type parameters

NameType
Dataany
Errorany
SWRKeyextends Key = StrictKey

Parameters

NameType
keySWRKey

Returns

SWRResponse<Data, Error, any>

Defined in

node_modules/swr/_internal/dist/index.d.ts:200

useSWR<Data, Error, SWRKey>(key, fetcher): SWRResponse<Data, Error, any>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
const { data, error } = useSWR('/api/user', fetcher)
if (error) return <div>failed to load</div>
if (!data) return <div>loading...</div>
return <div>hello {data.name}!</div>
}

Type parameters

NameType
Dataany
Errorany
SWRKeyextends Key = StrictKey

Parameters

NameType
keySWRKey
fetchernull | Fetcher<Data, SWRKey>

Returns

SWRResponse<Data, Error, any>

Defined in

node_modules/swr/_internal/dist/index.d.ts:201

useSWR<Data, Error, SWRKey, SWROptions>(key, config): SWRResponse<Data, Error, SWROptions>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
const { data, error } = useSWR('/api/user', fetcher)
if (error) return <div>failed to load</div>
if (!data) return <div>loading...</div>
return <div>hello {data.name}!</div>
}

Type parameters

NameType
Dataany
Errorany
SWRKeyextends Key = StrictKey
SWROptionsextends undefined | Partial<PublicConfiguration<Data, Error, Fetcher<Data, SWRKey>>> = undefined | Partial<PublicConfiguration<Data, Error, Fetcher<Data, SWRKey>>>

Parameters

NameType
keySWRKey
configSWROptions

Returns

SWRResponse<Data, Error, SWROptions>

Defined in

node_modules/swr/_internal/dist/index.d.ts:202

useSWR<Data, Error, SWRKey, SWROptions>(key, fetcher, config): SWRResponse<Data, Error, SWROptions>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
const { data, error } = useSWR('/api/user', fetcher)
if (error) return <div>failed to load</div>
if (!data) return <div>loading...</div>
return <div>hello {data.name}!</div>
}

Type parameters

NameType
Dataany
Errorany
SWRKeyextends Key = StrictKey
SWROptionsextends undefined | Partial<PublicConfiguration<Data, Error, Fetcher<Data, SWRKey>>> = undefined | Partial<PublicConfiguration<Data, Error, Fetcher<Data, SWRKey>>>

Parameters

NameType
keySWRKey
fetchernull | Fetcher<Data, SWRKey>
configSWROptions

Returns

SWRResponse<Data, Error, SWROptions>

Defined in

node_modules/swr/_internal/dist/index.d.ts:203

useSWR<Data, Error>(key): SWRResponse<Data, Error, any>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
const { data, error } = useSWR('/api/user', fetcher)
if (error) return <div>failed to load</div>
if (!data) return <div>loading...</div>
return <div>hello {data.name}!</div>
}

Type parameters

NameType
Dataany
Errorany

Parameters

NameType
keyKey

Returns

SWRResponse<Data, Error, any>

Defined in

node_modules/swr/_internal/dist/index.d.ts:204

useSWR<Data, Error>(key, fetcher): SWRResponse<Data, Error, any>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
const { data, error } = useSWR('/api/user', fetcher)
if (error) return <div>failed to load</div>
if (!data) return <div>loading...</div>
return <div>hello {data.name}!</div>
}

Type parameters

NameType
Dataany
Errorany

Parameters

NameType
keyKey
fetchernull | BareFetcher<Data>

Returns

SWRResponse<Data, Error, any>

Defined in

node_modules/swr/_internal/dist/index.d.ts:205

useSWR<Data, Error, SWROptions>(key, config): SWRResponse<Data, Error, SWROptions>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
const { data, error } = useSWR('/api/user', fetcher)
if (error) return <div>failed to load</div>
if (!data) return <div>loading...</div>
return <div>hello {data.name}!</div>
}

Type parameters

NameType
Dataany
Errorany
SWROptionsextends undefined | Partial<PublicConfiguration<Data, Error, BareFetcher<Data>>> = undefined | Partial<PublicConfiguration<Data, Error, BareFetcher<Data>>>

Parameters

NameType
keyKey
configSWROptions

Returns

SWRResponse<Data, Error, SWROptions>

Defined in

node_modules/swr/_internal/dist/index.d.ts:206

useSWR<Data, Error, SWROptions>(key, fetcher, config): SWRResponse<Data, Error, SWROptions>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
const { data, error } = useSWR('/api/user', fetcher)
if (error) return <div>failed to load</div>
if (!data) return <div>loading...</div>
return <div>hello {data.name}!</div>
}

Type parameters

NameType
Dataany
Errorany
SWROptionsextends undefined | Partial<PublicConfiguration<Data, Error, BareFetcher<Data>>> = undefined | Partial<PublicConfiguration<Data, Error, BareFetcher<Data>>>

Parameters

NameType
keyKey
fetchernull | BareFetcher<Data>
configSWROptions

Returns

SWRResponse<Data, Error, SWROptions>

Defined in

node_modules/swr/_internal/dist/index.d.ts:207


useSWRConfig

useSWRConfig(): FullConfiguration<any, any, BareFetcher<unknown>>

Returns

FullConfiguration<any, any, BareFetcher<unknown>>

Defined in

node_modules/swr/_internal/dist/index.d.ts:336


useSettings

useSettings(): Partial<SettingsContextProps>

Returns

Partial<SettingsContextProps>

Defined in

packages/core/src/react/provider/useSettings.ts:4


useThemeSetting

useThemeSetting(path, blockName?, defaultValue?, fallbackToGlobalSetting?): any

Returns a single theme setting normalized

Parameters

NameTypeDefault valueDescription
pathstringundefinedThe path to the setting
blockNamenull | string''The block name
defaultValueany''the default value to return
fallbackToGlobalSettingbooleantrueWhether it should fallback to global setting if blockName is passed but setting does not exist

Returns

any

Defined in

packages/core/src/react/provider/useThemeSetting.ts:22


useThemeSettings

useThemeSettings(): undefined | SettingsProperties & { blocks?: { core/archives?: SettingsPropertiesComplete ; core/audio?: SettingsPropertiesComplete ; core/block?: SettingsPropertiesComplete ; core/button?: SettingsPropertiesComplete ; core/buttons?: SettingsPropertiesComplete ; core/calendar?: SettingsPropertiesComplete ; core/categories?: SettingsPropertiesComplete ; core/code?: SettingsPropertiesComplete ; core/column?: SettingsPropertiesComplete ; core/columns?: SettingsPropertiesComplete ; core/comment-author-avatar?: SettingsPropertiesComplete ; core/comment-author-name?: SettingsPropertiesComplete ; core/comment-content?: SettingsPropertiesComplete ; core/comment-date?: SettingsPropertiesComplete ; core/comment-edit-link?: SettingsPropertiesComplete ; core/comment-reply-link?: SettingsPropertiesComplete ; core/comment-template?: SettingsPropertiesComplete ; core/comments-query-loop?: SettingsPropertiesComplete ; core/cover?: SettingsPropertiesComplete ; core/embed?: SettingsPropertiesComplete ; core/file?: SettingsPropertiesComplete ; core/freeform?: SettingsPropertiesComplete ; core/gallery?: SettingsPropertiesComplete ; core/group?: SettingsPropertiesComplete ; core/heading?: SettingsPropertiesComplete ; core/home-link?: SettingsPropertiesComplete ; core/html?: SettingsPropertiesComplete ; core/image?: SettingsPropertiesComplete ; core/latest-comments?: SettingsPropertiesComplete ; core/latest-posts?: SettingsPropertiesComplete ; core/legacy-widget?: SettingsPropertiesComplete ; core/list?: SettingsPropertiesComplete ; core/loginout?: SettingsPropertiesComplete ; core/media-text?: SettingsPropertiesComplete ; core/missing?: SettingsPropertiesComplete ; core/more?: SettingsPropertiesComplete ; core/navigation?: SettingsPropertiesComplete ; core/navigation-link?: SettingsPropertiesComplete ; core/nextpage?: SettingsPropertiesComplete ; core/page-list?: SettingsPropertiesComplete ; core/paragraph?: SettingsPropertiesComplete ; core/post-author?: SettingsPropertiesComplete ; core/post-comments?: SettingsPropertiesComplete ; core/post-comments-count?: SettingsPropertiesComplete ; core/post-comments-form?: SettingsPropertiesComplete ; core/post-comments-link?: SettingsPropertiesComplete ; core/post-content?: SettingsPropertiesComplete ; core/post-date?: SettingsPropertiesComplete ; core/post-excerpt?: SettingsPropertiesComplete ; core/post-featured-image?: SettingsPropertiesComplete ; core/post-navigation-link?: SettingsPropertiesComplete ; core/post-template?: SettingsPropertiesComplete ; core/post-terms?: SettingsPropertiesComplete ; core/post-title?: SettingsPropertiesComplete ; core/preformatted?: SettingsPropertiesComplete ; core/pullquote?: SettingsPropertiesComplete ; core/query?: SettingsPropertiesComplete ; core/query-pagination?: SettingsPropertiesComplete ; core/query-pagination-next?: SettingsPropertiesComplete ; core/query-pagination-numbers?: SettingsPropertiesComplete ; core/query-pagination-previous?: SettingsPropertiesComplete ; core/query-title?: SettingsPropertiesComplete ; core/quote?: SettingsPropertiesComplete ; core/rss?: SettingsPropertiesComplete ; core/search?: SettingsPropertiesComplete ; core/separator?: SettingsPropertiesComplete ; core/shortcode?: SettingsPropertiesComplete ; core/site-logo?: SettingsPropertiesComplete ; core/site-tagline?: SettingsPropertiesComplete ; core/site-title?: SettingsPropertiesComplete ; core/social-link?: SettingsPropertiesComplete ; core/social-links?: SettingsPropertiesComplete ; core/spacer?: SettingsPropertiesComplete ; core/table?: SettingsPropertiesComplete ; core/table-of-contents?: SettingsPropertiesComplete ; core/tag-cloud?: SettingsPropertiesComplete ; core/template-part?: SettingsPropertiesComplete ; core/term-description?: SettingsPropertiesComplete ; core/text-columns?: SettingsPropertiesComplete ; core/verse?: SettingsPropertiesComplete ; core/video?: SettingsPropertiesComplete ; core/widget-area?: SettingsPropertiesComplete ; core/widget-group?: SettingsPropertiesComplete } ; border?: { color?: boolean ; radius?: boolean ; style?: boolean ; width?: boolean } ; color?: { background?: boolean ; custom?: boolean ; customDuotone?: boolean ; customGradient?: boolean ; defaultGradients?: boolean ; defaultPalette?: boolean ; duotone?: SettingsDuotone ; gradients?: SettingsGradient ; link?: boolean ; palette?: SettingsColorPalette ; text?: boolean } ; custom?: { [k: string]: string | number | SettingsCustomAdditionalProperties; } ; layout?: { contentSize?: string ; wideSize?: string } ; spacing?: { blockGap?: null | boolean ; margin?: boolean ; padding?: boolean ; units?: string[] } ; typography?: { customFontSize?: boolean ; dropCap?: boolean ; fontFamilies?: { fontFamily?: string ; name?: string ; slug?: string }[] ; fontSizes?: { name?: string ; size?: string ; slug?: string }[] ; fontStyle?: boolean ; fontWeight?: boolean ; letterSpacing?: boolean ; lineHeight?: boolean ; textDecoration?: boolean ; textTransform?: boolean } }

Returns the raw theme.json settings definitions

Returns

undefined | SettingsProperties & { blocks?: { core/archives?: SettingsPropertiesComplete ; core/audio?: SettingsPropertiesComplete ; core/block?: SettingsPropertiesComplete ; core/button?: SettingsPropertiesComplete ; core/buttons?: SettingsPropertiesComplete ; core/calendar?: SettingsPropertiesComplete ; core/categories?: SettingsPropertiesComplete ; core/code?: SettingsPropertiesComplete ; core/column?: SettingsPropertiesComplete ; core/columns?: SettingsPropertiesComplete ; core/comment-author-avatar?: SettingsPropertiesComplete ; core/comment-author-name?: SettingsPropertiesComplete ; core/comment-content?: SettingsPropertiesComplete ; core/comment-date?: SettingsPropertiesComplete ; core/comment-edit-link?: SettingsPropertiesComplete ; core/comment-reply-link?: SettingsPropertiesComplete ; core/comment-template?: SettingsPropertiesComplete ; core/comments-query-loop?: SettingsPropertiesComplete ; core/cover?: SettingsPropertiesComplete ; core/embed?: SettingsPropertiesComplete ; core/file?: SettingsPropertiesComplete ; core/freeform?: SettingsPropertiesComplete ; core/gallery?: SettingsPropertiesComplete ; core/group?: SettingsPropertiesComplete ; core/heading?: SettingsPropertiesComplete ; core/home-link?: SettingsPropertiesComplete ; core/html?: SettingsPropertiesComplete ; core/image?: SettingsPropertiesComplete ; core/latest-comments?: SettingsPropertiesComplete ; core/latest-posts?: SettingsPropertiesComplete ; core/legacy-widget?: SettingsPropertiesComplete ; core/list?: SettingsPropertiesComplete ; core/loginout?: SettingsPropertiesComplete ; core/media-text?: SettingsPropertiesComplete ; core/missing?: SettingsPropertiesComplete ; core/more?: SettingsPropertiesComplete ; core/navigation?: SettingsPropertiesComplete ; core/navigation-link?: SettingsPropertiesComplete ; core/nextpage?: SettingsPropertiesComplete ; core/page-list?: SettingsPropertiesComplete ; core/paragraph?: SettingsPropertiesComplete ; core/post-author?: SettingsPropertiesComplete ; core/post-comments?: SettingsPropertiesComplete ; core/post-comments-count?: SettingsPropertiesComplete ; core/post-comments-form?: SettingsPropertiesComplete ; core/post-comments-link?: SettingsPropertiesComplete ; core/post-content?: SettingsPropertiesComplete ; core/post-date?: SettingsPropertiesComplete ; core/post-excerpt?: SettingsPropertiesComplete ; core/post-featured-image?: SettingsPropertiesComplete ; core/post-navigation-link?: SettingsPropertiesComplete ; core/post-template?: SettingsPropertiesComplete ; core/post-terms?: SettingsPropertiesComplete ; core/post-title?: SettingsPropertiesComplete ; core/preformatted?: SettingsPropertiesComplete ; core/pullquote?: SettingsPropertiesComplete ; core/query?: SettingsPropertiesComplete ; core/query-pagination?: SettingsPropertiesComplete ; core/query-pagination-next?: SettingsPropertiesComplete ; core/query-pagination-numbers?: SettingsPropertiesComplete ; core/query-pagination-previous?: SettingsPropertiesComplete ; core/query-title?: SettingsPropertiesComplete ; core/quote?: SettingsPropertiesComplete ; core/rss?: SettingsPropertiesComplete ; core/search?: SettingsPropertiesComplete ; core/separator?: SettingsPropertiesComplete ; core/shortcode?: SettingsPropertiesComplete ; core/site-logo?: SettingsPropertiesComplete ; core/site-tagline?: SettingsPropertiesComplete ; core/site-title?: SettingsPropertiesComplete ; core/social-link?: SettingsPropertiesComplete ; core/social-links?: SettingsPropertiesComplete ; core/spacer?: SettingsPropertiesComplete ; core/table?: SettingsPropertiesComplete ; core/table-of-contents?: SettingsPropertiesComplete ; core/tag-cloud?: SettingsPropertiesComplete ; core/template-part?: SettingsPropertiesComplete ; core/term-description?: SettingsPropertiesComplete ; core/text-columns?: SettingsPropertiesComplete ; core/verse?: SettingsPropertiesComplete ; core/video?: SettingsPropertiesComplete ; core/widget-area?: SettingsPropertiesComplete ; core/widget-group?: SettingsPropertiesComplete } ; border?: { color?: boolean ; radius?: boolean ; style?: boolean ; width?: boolean } ; color?: { background?: boolean ; custom?: boolean ; customDuotone?: boolean ; customGradient?: boolean ; defaultGradients?: boolean ; defaultPalette?: boolean ; duotone?: SettingsDuotone ; gradients?: SettingsGradient ; link?: boolean ; palette?: SettingsColorPalette ; text?: boolean } ; custom?: { [k: string]: string | number | SettingsCustomAdditionalProperties; } ; layout?: { contentSize?: string ; wideSize?: string } ; spacing?: { blockGap?: null | boolean ; margin?: boolean ; padding?: boolean ; units?: string[] } ; typography?: { customFontSize?: boolean ; dropCap?: boolean ; fontFamilies?: { fontFamily?: string ; name?: string ; slug?: string }[] ; fontSizes?: { name?: string ; size?: string ; slug?: string }[] ; fontStyle?: boolean ; fontWeight?: boolean ; letterSpacing?: boolean ; lineHeight?: boolean ; textDecoration?: boolean ; textTransform?: boolean } }

Defined in

packages/core/src/react/provider/useThemeSettings.ts:9


useThemeStyles

useThemeStyles(): undefined | StylesProperties & { blocks?: { core/archives?: StylesPropertiesAndElementsComplete ; core/audio?: StylesPropertiesAndElementsComplete ; core/block?: StylesPropertiesAndElementsComplete ; core/button?: StylesPropertiesAndElementsComplete ; core/buttons?: StylesPropertiesAndElementsComplete ; core/calendar?: StylesPropertiesAndElementsComplete ; core/categories?: StylesPropertiesAndElementsComplete ; core/code?: StylesPropertiesAndElementsComplete ; core/column?: StylesPropertiesAndElementsComplete ; core/columns?: StylesPropertiesAndElementsComplete ; core/comment-author-avatar?: StylesPropertiesAndElementsComplete ; core/comment-author-name?: StylesPropertiesAndElementsComplete ; core/comment-content?: StylesPropertiesAndElementsComplete ; core/comment-date?: StylesPropertiesAndElementsComplete ; core/comment-edit-link?: StylesPropertiesAndElementsComplete ; core/comment-reply-link?: StylesPropertiesAndElementsComplete ; core/comment-template?: StylesPropertiesAndElementsComplete ; core/comments-query-loop?: StylesPropertiesAndElementsComplete ; core/cover?: StylesPropertiesAndElementsComplete ; core/embed?: StylesPropertiesAndElementsComplete ; core/file?: StylesPropertiesAndElementsComplete ; core/freeform?: StylesPropertiesAndElementsComplete ; core/gallery?: StylesPropertiesAndElementsComplete ; core/group?: StylesPropertiesAndElementsComplete ; core/heading?: StylesPropertiesAndElementsComplete ; core/home-link?: StylesPropertiesAndElementsComplete ; core/html?: StylesPropertiesAndElementsComplete ; core/image?: StylesPropertiesAndElementsComplete ; core/latest-comments?: StylesPropertiesAndElementsComplete ; core/latest-posts?: StylesPropertiesAndElementsComplete ; core/legacy-widget?: StylesPropertiesAndElementsComplete ; core/list?: StylesPropertiesAndElementsComplete ; core/loginout?: StylesPropertiesAndElementsComplete ; core/media-text?: StylesPropertiesAndElementsComplete ; core/missing?: StylesPropertiesAndElementsComplete ; core/more?: StylesPropertiesAndElementsComplete ; core/navigation?: StylesPropertiesAndElementsComplete ; core/navigation-link?: StylesPropertiesAndElementsComplete ; core/nextpage?: StylesPropertiesAndElementsComplete ; core/page-list?: StylesPropertiesAndElementsComplete ; core/paragraph?: StylesPropertiesAndElementsComplete ; core/post-author?: StylesPropertiesAndElementsComplete ; core/post-comments?: StylesPropertiesAndElementsComplete ; core/post-comments-count?: StylesPropertiesAndElementsComplete ; core/post-comments-form?: StylesPropertiesAndElementsComplete ; core/post-comments-link?: StylesPropertiesAndElementsComplete ; core/post-content?: StylesPropertiesAndElementsComplete ; core/post-date?: StylesPropertiesAndElementsComplete ; core/post-excerpt?: StylesPropertiesAndElementsComplete ; core/post-featured-image?: StylesPropertiesAndElementsComplete ; core/post-navigation-link?: StylesPropertiesAndElementsComplete ; core/post-template?: StylesPropertiesAndElementsComplete ; core/post-terms?: StylesPropertiesAndElementsComplete ; core/post-title?: StylesPropertiesAndElementsComplete ; core/preformatted?: StylesPropertiesAndElementsComplete ; core/pullquote?: StylesPropertiesAndElementsComplete ; core/query?: StylesPropertiesAndElementsComplete ; core/query-pagination?: StylesPropertiesAndElementsComplete ; core/query-pagination-next?: StylesPropertiesAndElementsComplete ; core/query-pagination-numbers?: StylesPropertiesAndElementsComplete ; core/query-pagination-previous?: StylesPropertiesAndElementsComplete ; core/query-title?: StylesPropertiesAndElementsComplete ; core/quote?: StylesPropertiesAndElementsComplete ; core/rss?: StylesPropertiesAndElementsComplete ; core/search?: StylesPropertiesAndElementsComplete ; core/separator?: StylesPropertiesAndElementsComplete ; core/shortcode?: StylesPropertiesAndElementsComplete ; core/site-logo?: StylesPropertiesAndElementsComplete ; core/site-tagline?: StylesPropertiesAndElementsComplete ; core/site-title?: StylesPropertiesAndElementsComplete ; core/social-link?: StylesPropertiesAndElementsComplete ; core/social-links?: StylesPropertiesAndElementsComplete ; core/spacer?: StylesPropertiesAndElementsComplete ; core/table?: StylesPropertiesAndElementsComplete ; core/table-of-contents?: StylesPropertiesAndElementsComplete ; core/tag-cloud?: StylesPropertiesAndElementsComplete ; core/template-part?: StylesPropertiesAndElementsComplete ; core/term-description?: StylesPropertiesAndElementsComplete ; core/text-columns?: StylesPropertiesAndElementsComplete ; core/verse?: StylesPropertiesAndElementsComplete ; core/video?: StylesPropertiesAndElementsComplete ; core/widget-area?: StylesPropertiesAndElementsComplete ; core/widget-group?: StylesPropertiesAndElementsComplete } ; border?: unknown ; color?: unknown ; elements?: { h1?: StylesPropertiesComplete ; h2?: StylesPropertiesComplete ; h3?: StylesPropertiesComplete ; h4?: StylesPropertiesComplete ; h5?: StylesPropertiesComplete ; h6?: StylesPropertiesComplete ; link?: StylesPropertiesComplete } ; spacing?: unknown ; typography?: unknown }

Returns the theme.json styles definitions

Returns

undefined | StylesProperties & { blocks?: { core/archives?: StylesPropertiesAndElementsComplete ; core/audio?: StylesPropertiesAndElementsComplete ; core/block?: StylesPropertiesAndElementsComplete ; core/button?: StylesPropertiesAndElementsComplete ; core/buttons?: StylesPropertiesAndElementsComplete ; core/calendar?: StylesPropertiesAndElementsComplete ; core/categories?: StylesPropertiesAndElementsComplete ; core/code?: StylesPropertiesAndElementsComplete ; core/column?: StylesPropertiesAndElementsComplete ; core/columns?: StylesPropertiesAndElementsComplete ; core/comment-author-avatar?: StylesPropertiesAndElementsComplete ; core/comment-author-name?: StylesPropertiesAndElementsComplete ; core/comment-content?: StylesPropertiesAndElementsComplete ; core/comment-date?: StylesPropertiesAndElementsComplete ; core/comment-edit-link?: StylesPropertiesAndElementsComplete ; core/comment-reply-link?: StylesPropertiesAndElementsComplete ; core/comment-template?: StylesPropertiesAndElementsComplete ; core/comments-query-loop?: StylesPropertiesAndElementsComplete ; core/cover?: StylesPropertiesAndElementsComplete ; core/embed?: StylesPropertiesAndElementsComplete ; core/file?: StylesPropertiesAndElementsComplete ; core/freeform?: StylesPropertiesAndElementsComplete ; core/gallery?: StylesPropertiesAndElementsComplete ; core/group?: StylesPropertiesAndElementsComplete ; core/heading?: StylesPropertiesAndElementsComplete ; core/home-link?: StylesPropertiesAndElementsComplete ; core/html?: StylesPropertiesAndElementsComplete ; core/image?: StylesPropertiesAndElementsComplete ; core/latest-comments?: StylesPropertiesAndElementsComplete ; core/latest-posts?: StylesPropertiesAndElementsComplete ; core/legacy-widget?: StylesPropertiesAndElementsComplete ; core/list?: StylesPropertiesAndElementsComplete ; core/loginout?: StylesPropertiesAndElementsComplete ; core/media-text?: StylesPropertiesAndElementsComplete ; core/missing?: StylesPropertiesAndElementsComplete ; core/more?: StylesPropertiesAndElementsComplete ; core/navigation?: StylesPropertiesAndElementsComplete ; core/navigation-link?: StylesPropertiesAndElementsComplete ; core/nextpage?: StylesPropertiesAndElementsComplete ; core/page-list?: StylesPropertiesAndElementsComplete ; core/paragraph?: StylesPropertiesAndElementsComplete ; core/post-author?: StylesPropertiesAndElementsComplete ; core/post-comments?: StylesPropertiesAndElementsComplete ; core/post-comments-count?: StylesPropertiesAndElementsComplete ; core/post-comments-form?: StylesPropertiesAndElementsComplete ; core/post-comments-link?: StylesPropertiesAndElementsComplete ; core/post-content?: StylesPropertiesAndElementsComplete ; core/post-date?: StylesPropertiesAndElementsComplete ; core/post-excerpt?: StylesPropertiesAndElementsComplete ; core/post-featured-image?: StylesPropertiesAndElementsComplete ; core/post-navigation-link?: StylesPropertiesAndElementsComplete ; core/post-template?: StylesPropertiesAndElementsComplete ; core/post-terms?: StylesPropertiesAndElementsComplete ; core/post-title?: StylesPropertiesAndElementsComplete ; core/preformatted?: StylesPropertiesAndElementsComplete ; core/pullquote?: StylesPropertiesAndElementsComplete ; core/query?: StylesPropertiesAndElementsComplete ; core/query-pagination?: StylesPropertiesAndElementsComplete ; core/query-pagination-next?: StylesPropertiesAndElementsComplete ; core/query-pagination-numbers?: StylesPropertiesAndElementsComplete ; core/query-pagination-previous?: StylesPropertiesAndElementsComplete ; core/query-title?: StylesPropertiesAndElementsComplete ; core/quote?: StylesPropertiesAndElementsComplete ; core/rss?: StylesPropertiesAndElementsComplete ; core/search?: StylesPropertiesAndElementsComplete ; core/separator?: StylesPropertiesAndElementsComplete ; core/shortcode?: StylesPropertiesAndElementsComplete ; core/site-logo?: StylesPropertiesAndElementsComplete ; core/site-tagline?: StylesPropertiesAndElementsComplete ; core/site-title?: StylesPropertiesAndElementsComplete ; core/social-link?: StylesPropertiesAndElementsComplete ; core/social-links?: StylesPropertiesAndElementsComplete ; core/spacer?: StylesPropertiesAndElementsComplete ; core/table?: StylesPropertiesAndElementsComplete ; core/table-of-contents?: StylesPropertiesAndElementsComplete ; core/tag-cloud?: StylesPropertiesAndElementsComplete ; core/template-part?: StylesPropertiesAndElementsComplete ; core/term-description?: StylesPropertiesAndElementsComplete ; core/text-columns?: StylesPropertiesAndElementsComplete ; core/verse?: StylesPropertiesAndElementsComplete ; core/video?: StylesPropertiesAndElementsComplete ; core/widget-area?: StylesPropertiesAndElementsComplete ; core/widget-group?: StylesPropertiesAndElementsComplete } ; border?: unknown ; color?: unknown ; elements?: { h1?: StylesPropertiesComplete ; h2?: StylesPropertiesComplete ; h3?: StylesPropertiesComplete ; h4?: StylesPropertiesComplete ; h5?: StylesPropertiesComplete ; h6?: StylesPropertiesComplete ; link?: StylesPropertiesComplete } ; spacing?: unknown ; typography?: unknown }

Defined in

packages/core/src/react/provider/useThemeStyles.ts:9

React Components

BlocksRenderer

BlocksRenderer(props): Element

The BlocksRenderer components provides an easy way to convert HTML markup into corresponding React components.

The BlocksRenderer component takes in arbitrary html markup and receives a list of react components -as children that allows replacing dom nodes with React Components.

The html prop is sanitized through wpKsesPost so it's safe for rendering arbitrary html markup.

The children components must implement the BlockProps interface

Usage

Usage with the test function

<BlocksRenderer html={html}>
<MyLinkBlock test={(node) => isAnchorTag(node, { isInternalLink: true })} />
</BlocksRenderer>

Usage with classList and tagName props

<BlocksRenderer html={html}>
<MyLinkBlock tagName="a" classList="my-special-anchor" />
</BlocksRenderer>

Parameters

NameTypeDescription
propsBlockRendererPropsComponent properties

Returns

Element

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:165


HtmlDecoder

HtmlDecoder(props, context?): null | ReactElement<any, any>

The HtmlDecoder simply decodes html entities

Any actual html markup gets stripped before decoding html entities. If you need to render HTML use SafeHtml

Usage

<HtmlDecoder html="Hello world! &#8211; foo bar &#8211;" />

Parameters

NameTypeDescription
propsPropsWithChildren<HtmlDecodeProps>Component properties
context?any-

Returns

null | ReactElement<any, any>

Defined in

node_modules/@types/react/index.d.ts:542


SafeHtml

SafeHtml(props, context?): null | ReactElement<any, any>

The SafeHtml component provides an easy way to safely render HTML

The html prop is sanitized through wpKsesPost so it's safe for rendering arbitrary html markup.

Usage

<SafeHtml html="<div><p>hello world</p> div content</div>" />

Parameters

NameTypeDescription
propsPropsWithChildren<SafeHtmlProps>Component properties
context?any-

Returns

null | ReactElement<any, any>

Defined in

node_modules/@types/react/index.d.ts:542

Finely crafted by 10up, ©2023.

- +as children that allows replacing dom nodes with React Components.

The html prop is sanitized through wpKsesPost so it's safe for rendering arbitrary html markup.

The children components must implement the BlockProps interface

Usage

Usage with the test function

<BlocksRenderer html={html}>
<MyLinkBlock test={(node) => isAnchorTag(node, { isInternalLink: true })} />
</BlocksRenderer>

Usage with classList and tagName props

<BlocksRenderer html={html}>
<MyLinkBlock tagName="a" classList="my-special-anchor" />
</BlocksRenderer>

Parameters

NameTypeDescription
propsBlockRendererPropsComponent properties

Returns

Element

Defined in

packages/core/src/react/components/BlocksRenderer.tsx:165


HtmlDecoder

HtmlDecoder(props, context?): null | ReactElement<any, any>

The HtmlDecoder simply decodes html entities

Any actual html markup gets stripped before decoding html entities. If you need to render HTML use SafeHtml

Usage

<HtmlDecoder html="Hello world! &#8211; foo bar &#8211;" />

Parameters

NameTypeDescription
propsPropsWithChildren<HtmlDecodeProps>Component properties
context?any-

Returns

null | ReactElement<any, any>

Defined in

node_modules/@types/react/index.d.ts:542


SafeHtml

SafeHtml(props, context?): null | ReactElement<any, any>

The SafeHtml component provides an easy way to safely render HTML

The html prop is sanitized through wpKsesPost so it's safe for rendering arbitrary html markup.

Usage

<SafeHtml html="<div><p>hello world</p> div content</div>" />

Parameters

NameTypeDescription
propsPropsWithChildren<SafeHtmlProps>Component properties
context?any-

Returns

null | ReactElement<any, any>

Defined in

node_modules/@types/react/index.d.ts:542

+ \ No newline at end of file diff --git a/api/namespaces/headstartwp_next.config/index.html b/api/namespaces/headstartwp_next.config/index.html index 9c88bc74b..af6421bf5 100644 --- a/api/namespaces/headstartwp_next.config/index.html +++ b/api/namespaces/headstartwp_next.config/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Namespace: config

@headstartwp/next.config

@headstartwp/next/config

The config export of the @headstartwp/next package.

Usage

import { withHeadlessConfig } from '@headstartwp/next/config';

Functions

withHeadlessConfig

withHeadlessConfig(nextConfig?, headlessConfig?, withHeadstarWPConfigOptions?): NextConfig

Parameters

NameType
nextConfigNextConfig
headlessConfigHeadlessConfig
withHeadstarWPConfigOptionsObject
withHeadstarWPConfigOptions.injectConfigboolean

Returns

NextConfig

Defined in

packages/next/src/config/withHeadstartWPConfig.ts:268


withHeadstartWPConfig

withHeadstartWPConfig(nextConfig?, headlessConfig?, withHeadstarWPConfigOptions?): NextConfig

HOC used to wrap the nextjs config object with the headless config object.

Parameters

NameTypeDescription
nextConfigNextConfigThe nextjs config object
headlessConfigHeadlessConfigThe headless config
withHeadstarWPConfigOptionsObject
withHeadstarWPConfigOptions.injectConfigboolean-

Returns

NextConfig

Defined in

packages/next/src/config/withHeadstartWPConfig.ts:58

- +
Skip to main content

Namespace: config

@headstartwp/next.config

@headstartwp/next/config

The config export of the @headstartwp/next package.

Usage

import { withHeadlessConfig } from '@headstartwp/next/config';

Functions

withHeadlessConfig

withHeadlessConfig(nextConfig?, headlessConfig?, withHeadstarWPConfigOptions?): NextConfig

Parameters

NameType
nextConfigNextConfig
headlessConfigHeadlessConfig
withHeadstarWPConfigOptionsObject
withHeadstarWPConfigOptions.injectConfigboolean

Returns

NextConfig

Defined in

packages/next/src/config/withHeadstartWPConfig.ts:268


withHeadstartWPConfig

withHeadstartWPConfig(nextConfig?, headlessConfig?, withHeadstarWPConfigOptions?): NextConfig

HOC used to wrap the nextjs config object with the headless config object.

Parameters

NameTypeDescription
nextConfigNextConfigThe nextjs config object
headlessConfigHeadlessConfigThe headless config
withHeadstarWPConfigOptionsObject
withHeadstarWPConfigOptions.injectConfigboolean-

Returns

NextConfig

Defined in

packages/next/src/config/withHeadstartWPConfig.ts:58

+ \ No newline at end of file diff --git a/api/namespaces/headstartwp_next.middlewares/index.html b/api/namespaces/headstartwp_next.middlewares/index.html index ea77c344b..6a45cb4ae 100644 --- a/api/namespaces/headstartwp_next.middlewares/index.html +++ b/api/namespaces/headstartwp_next.middlewares/index.html @@ -7,13 +7,13 @@ - +
-
Skip to main content

Namespace: middlewares

@headstartwp/next.middlewares

@headstartwp/next/middlewares

The middlewares export of the `@headstartwp/next' package.

Usage

import { appMiddleware } from '@headstartwp/next/middlewares';

Functions

AppMiddleware

AppMiddleware(req): Promise<NextResponse<unknown>>

Parameters

NameType
reqNextRequest

Returns

Promise<NextResponse<unknown>>

Defined in

packages/next/src/middlewares/appMidleware.ts:15

- +
Skip to main content

Namespace: middlewares

@headstartwp/next.middlewares

@headstartwp/next/middlewares

The middlewares export of the `@headstartwp/next' package.

Usage

import { appMiddleware } from '@headstartwp/next/middlewares';

Functions

AppMiddleware

AppMiddleware(req): Promise<NextResponse<unknown>>

Parameters

NameType
reqNextRequest

Returns

Promise<NextResponse<unknown>>

Defined in

packages/next/src/middlewares/appMidleware.ts:15

+ \ No newline at end of file diff --git a/assets/js/0065d4a9.36624222.js b/assets/js/0065d4a9.0892c98e.js similarity index 99% rename from assets/js/0065d4a9.36624222.js rename to assets/js/0065d4a9.0892c98e.js index 8ee5816f2..9521b67a1 100644 --- a/assets/js/0065d4a9.36624222.js +++ b/assets/js/0065d4a9.0892c98e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3035],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>u});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var d=a.createContext({}),p=function(e){var t=a.useContext(d),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return a.createElement(d.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),c=p(r),m=n,u=c["".concat(d,".").concat(m)]||c[m]||k[m]||i;return r?a.createElement(u,l(l({ref:t},s),{},{components:r})):a.createElement(u,l({ref:t},s))}));function u(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=m;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o[c]="string"==typeof e?e:n,l[1]=o;for(var p=2;p{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.FrameworkError",title:"Class: FrameworkError",sidebar_label:"@headstartwp/core.FrameworkError",custom_edit_url:null},l=void 0,o={unversionedId:"classes/headstartwp_core.FrameworkError",id:"classes/headstartwp_core.FrameworkError",title:"Class: FrameworkError",description:"@headstartwp/core.FrameworkError",source:"@site/docs/classes/headstartwp_core.FrameworkError.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.FrameworkError",permalink:"/docs/api/classes/headstartwp_core.FrameworkError",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.FrameworkError",title:"Class: FrameworkError",sidebar_label:"@headstartwp/core.FrameworkError",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.FetchError",permalink:"/docs/api/classes/headstartwp_core.FetchError"},next:{title:"@headstartwp/core.NotFoundError",permalink:"/docs/api/classes/headstartwp_core.NotFoundError"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"cause",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"stack",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"prepareStackTrace",id:"preparestacktrace",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:p};function c(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".FrameworkError"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("inlineCode",{parentName:"p"},"Error")),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"FrameworkError"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new FrameworkError"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"message"),")"),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"message")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,"Error.constructor"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/errors.ts#L32"},"packages/core/src/utils/errors.ts:32")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"cause"},"cause"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"cause"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,"Error.cause"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"message"},"message"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"message"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,"Error.message"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1054"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,"Error.name"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1053"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"stack"},"stack"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"stack"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,"Error.stack"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1055"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:127"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"preparestacktrace"},"prepareStackTrace"),(0,n.kt)("p",null,"\u25aa ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"prepareStackTrace"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"err"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"stackTraces"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"CallSite"),"[]) => ",(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"err"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"stackTraces"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("p",null,"Optional override for formatting stack traces"),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"See"))),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces"},"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces")),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"err")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Error"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"stackTraces")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"CallSite"),"[]")))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,"Error.prepareStackTrace"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:140"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"stacktracelimit"},"stackTraceLimit"),(0,n.kt)("p",null,"\u25aa ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("strong",{parentName:"p"},"stackTraceLimit"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,"Error.stackTraceLimit"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:142"),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"capturestacktrace"},"captureStackTrace"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("strong",{parentName:"p"},"captureStackTrace"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"targetObject"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"constructorOpt?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"Create .stack property on a target object"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"targetObject")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Object"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"constructorOpt?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Function"))))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,"Error.captureStackTrace"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:133"))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3035],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>u});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var d=a.createContext({}),p=function(e){var t=a.useContext(d),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return a.createElement(d.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),c=p(r),m=n,u=c["".concat(d,".").concat(m)]||c[m]||k[m]||i;return r?a.createElement(u,l(l({ref:t},s),{},{components:r})):a.createElement(u,l({ref:t},s))}));function u(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=m;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o[c]="string"==typeof e?e:n,l[1]=o;for(var p=2;p{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.FrameworkError",title:"Class: FrameworkError",sidebar_label:"@headstartwp/core.FrameworkError",custom_edit_url:null},l=void 0,o={unversionedId:"classes/headstartwp_core.FrameworkError",id:"classes/headstartwp_core.FrameworkError",title:"Class: FrameworkError",description:"@headstartwp/core.FrameworkError",source:"@site/docs/classes/headstartwp_core.FrameworkError.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.FrameworkError",permalink:"/docs/api/classes/headstartwp_core.FrameworkError",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.FrameworkError",title:"Class: FrameworkError",sidebar_label:"@headstartwp/core.FrameworkError",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.FetchError",permalink:"/docs/api/classes/headstartwp_core.FetchError"},next:{title:"@headstartwp/core.NotFoundError",permalink:"/docs/api/classes/headstartwp_core.NotFoundError"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"cause",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"stack",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"prepareStackTrace",id:"preparestacktrace",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:p};function c(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".FrameworkError"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("inlineCode",{parentName:"p"},"Error")),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"FrameworkError"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new FrameworkError"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"message"),")"),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"message")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,"Error.constructor"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/errors.ts#L32"},"packages/core/src/utils/errors.ts:32")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"cause"},"cause"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"cause"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,"Error.cause"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"message"},"message"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"message"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,"Error.message"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1054"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,"Error.name"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1053"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"stack"},"stack"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"stack"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,"Error.stack"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1055"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:127"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"preparestacktrace"},"prepareStackTrace"),(0,n.kt)("p",null,"\u25aa ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"prepareStackTrace"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"err"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"stackTraces"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"CallSite"),"[]) => ",(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"err"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"stackTraces"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("p",null,"Optional override for formatting stack traces"),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"See"))),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces"},"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces")),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"err")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Error"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"stackTraces")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"CallSite"),"[]")))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,"Error.prepareStackTrace"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:140"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"stacktracelimit"},"stackTraceLimit"),(0,n.kt)("p",null,"\u25aa ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("strong",{parentName:"p"},"stackTraceLimit"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,"Error.stackTraceLimit"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:142"),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"capturestacktrace"},"captureStackTrace"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("strong",{parentName:"p"},"captureStackTrace"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"targetObject"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"constructorOpt?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"Create .stack property on a target object"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"targetObject")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Object"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"constructorOpt?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Function"))))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,"Error.captureStackTrace"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:133"))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/00a631a6.d11f19fc.js b/assets/js/00a631a6.fb4b4afe.js similarity index 98% rename from assets/js/00a631a6.d11f19fc.js rename to assets/js/00a631a6.fb4b4afe.js index 6d00a66ef..77faf5656 100644 --- a/assets/js/00a631a6.d11f19fc.js +++ b/assets/js/00a631a6.fb4b4afe.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9605],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>h});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function s(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var c=n.createContext({}),u=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},p=function(e){var t=u(e.components);return n.createElement(c.Provider,{value:t},e.children)},l="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,c=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),l=u(r),d=a,h=l["".concat(c,".").concat(d)]||l[d]||m[d]||o;return r?n.createElement(h,s(s({ref:t},p),{},{components:r})):n.createElement(h,s({ref:t},p))}));function h(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,s=new Array(o);s[0]=d;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[l]="string"==typeof e?e:a,s[1]=i;for(var u=2;u{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>i,toc:()=>u});var n=r(7462),a=(r(7294),r(3905));const o={slug:"/data-fetching/useterms",sidebar_position:4},s="The useTerms hook",i={unversionedId:"Data Fetching/useTerms",id:"Data Fetching/useTerms",title:"The useTerms hook",description:"The useTerms hook is the Next.js binding for the useFetchTerms.",source:"@site/documentation/02 - Data Fetching/useTerms.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/useterms",permalink:"/docs/learn/data-fetching/useterms",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/useTerms.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:4,frontMatter:{slug:"/data-fetching/useterms",sidebar_position:4},sidebar:"tutorialSidebar",previous:{title:"The usePostOrPosts hook",permalink:"/docs/learn/data-fetching/use-post-or-posts"},next:{title:"The useSearch hook",permalink:"/docs/learn/data-fetching/usesearch"}},c={},u=[{value:"Basic Usage",id:"basic-usage",level:2}],p={toc:u};function l(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"the-useterms-hook"},"The useTerms hook"),(0,a.kt)("blockquote",null,(0,a.kt)("p",{parentName:"blockquote"},"The ",(0,a.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#useterms"},"useTerms")," hook is the Next.js binding for the ",(0,a.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchterms"},"useFetchTerms"),".")),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"useTerms")," hook returns terms for a given WordPress taxonomy."),(0,a.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"const {\n data: { terms },\n} = useTerms({ taxonomy: 'category' });\n")),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"You do not need to use ",(0,a.kt)("inlineCode",{parentName:"p"},"useTerms")," if you simply need to access the term object for a taxonomy archive page (e.g category archive). You should use the ",(0,a.kt)("inlineCode",{parentName:"p"},"queriedObject")," from the ",(0,a.kt)("inlineCode",{parentName:"p"},"usePosts")," hook. See ",(0,a.kt)("a",{parentName:"p",href:"/learn/data-fetching/useposts/#queried-object"},"usePosts docs")," for more details.")))}l.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9605],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>h});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function s(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var c=n.createContext({}),u=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},p=function(e){var t=u(e.components);return n.createElement(c.Provider,{value:t},e.children)},l="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,c=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),l=u(r),d=a,h=l["".concat(c,".").concat(d)]||l[d]||m[d]||o;return r?n.createElement(h,s(s({ref:t},p),{},{components:r})):n.createElement(h,s({ref:t},p))}));function h(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,s=new Array(o);s[0]=d;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[l]="string"==typeof e?e:a,s[1]=i;for(var u=2;u{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>i,toc:()=>u});var n=r(7462),a=(r(7294),r(3905));const o={slug:"/data-fetching/useterms",sidebar_position:4},s="The useTerms hook",i={unversionedId:"Data Fetching/useTerms",id:"Data Fetching/useTerms",title:"The useTerms hook",description:"The useTerms hook is the Next.js binding for the useFetchTerms.",source:"@site/documentation/02 - Data Fetching/useTerms.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/useterms",permalink:"/docs/learn/data-fetching/useterms",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/useTerms.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:4,frontMatter:{slug:"/data-fetching/useterms",sidebar_position:4},sidebar:"tutorialSidebar",previous:{title:"The usePostOrPosts hook",permalink:"/docs/learn/data-fetching/use-post-or-posts"},next:{title:"The useSearch hook",permalink:"/docs/learn/data-fetching/usesearch"}},c={},u=[{value:"Basic Usage",id:"basic-usage",level:2}],p={toc:u};function l(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"the-useterms-hook"},"The useTerms hook"),(0,a.kt)("blockquote",null,(0,a.kt)("p",{parentName:"blockquote"},"The ",(0,a.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#useterms"},"useTerms")," hook is the Next.js binding for the ",(0,a.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchterms"},"useFetchTerms"),".")),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"useTerms")," hook returns terms for a given WordPress taxonomy."),(0,a.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"const {\n data: { terms },\n} = useTerms({ taxonomy: 'category' });\n")),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"You do not need to use ",(0,a.kt)("inlineCode",{parentName:"p"},"useTerms")," if you simply need to access the term object for a taxonomy archive page (e.g category archive). You should use the ",(0,a.kt)("inlineCode",{parentName:"p"},"queriedObject")," from the ",(0,a.kt)("inlineCode",{parentName:"p"},"usePosts")," hook. See ",(0,a.kt)("a",{parentName:"p",href:"/learn/data-fetching/useposts/#queried-object"},"usePosts docs")," for more details.")))}l.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/00b96e45.ba85b854.js b/assets/js/00b96e45.dab39b10.js similarity index 88% rename from assets/js/00b96e45.ba85b854.js rename to assets/js/00b96e45.dab39b10.js index 64fe84bb3..3b394ae1a 100644 --- a/assets/js/00b96e45.ba85b854.js +++ b/assets/js/00b96e45.dab39b10.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4858],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>f});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var c=a.createContext({}),s=function(e){var t=a.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},p=function(e){var t=s(e.components);return a.createElement(c.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,c=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),d=s(r),k=n,f=d["".concat(c,".").concat(k)]||d[k]||u[k]||o;return r?a.createElement(f,l(l({ref:t},p),{},{components:r})):a.createElement(f,l({ref:t},p))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,l=new Array(o);l[0]=k;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[d]="string"==typeof e?e:n,l[1]=i;for(var s=2;s{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>s});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.Colors",title:"Interface: Colors",sidebar_label:"@headstartwp/core.react.Colors",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.Colors",id:"interfaces/headstartwp_core.react.Colors",title:"Interface: Colors",description:"@headstartwp/core.react.Colors",source:"@site/docs/interfaces/headstartwp_core.react.Colors.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.Colors",permalink:"/docs/api/interfaces/headstartwp_core.react.Colors",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.Colors",title:"Interface: Colors",sidebar_label:"@headstartwp/core.react.Colors",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.CodeBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},next:{title:"@headstartwp/core.react.ColumnBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"}},c={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"backgroundColor",id:"backgroundcolor",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"backgroundColorSlug",id:"backgroundcolorslug",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"gradient",id:"gradient",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"gradientSlug",id:"gradientslug",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"linkColor",id:"linkcolor",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"linkColorSlug",id:"linkcolorslug",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"textColor",id:"textcolor",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"textColorSlug",id:"textcolorslug",level:3},{value:"Defined in",id:"defined-in-7",level:4}],p={toc:s};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".Colors"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Colors"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.BlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"BlockAttributes"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"backgroundcolor"},"backgroundColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"backgroundColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L6"},"packages/core/src/react/blocks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"backgroundcolorslug"},"backgroundColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"backgroundColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L5"},"packages/core/src/react/blocks/types.ts:5")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"gradient"},"gradient"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"gradient"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L8"},"packages/core/src/react/blocks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"gradientslug"},"gradientSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"gradientSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L7"},"packages/core/src/react/blocks/types.ts:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linkcolor"},"linkColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"linkColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L12"},"packages/core/src/react/blocks/types.ts:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linkcolorslug"},"linkColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"linkColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L11"},"packages/core/src/react/blocks/types.ts:11")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"textcolor"},"textColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"textColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L10"},"packages/core/src/react/blocks/types.ts:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"textcolorslug"},"textColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"textColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L9"},"packages/core/src/react/blocks/types.ts:9")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4858],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>g});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var c=a.createContext({}),s=function(e){var t=a.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},p=function(e){var t=s(e.components);return a.createElement(c.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,c=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),d=s(r),k=n,g=d["".concat(c,".").concat(k)]||d[k]||u[k]||o;return r?a.createElement(g,l(l({ref:t},p),{},{components:r})):a.createElement(g,l({ref:t},p))}));function g(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,l=new Array(o);l[0]=k;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[d]="string"==typeof e?e:n,l[1]=i;for(var s=2;s{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>s});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.Colors",title:"Interface: Colors",sidebar_label:"@headstartwp/core.react.Colors",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.Colors",id:"interfaces/headstartwp_core.react.Colors",title:"Interface: Colors",description:"@headstartwp/core.react.Colors",source:"@site/docs/interfaces/headstartwp_core.react.Colors.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.Colors",permalink:"/docs/api/interfaces/headstartwp_core.react.Colors",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.Colors",title:"Interface: Colors",sidebar_label:"@headstartwp/core.react.Colors",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.CodeBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},next:{title:"@headstartwp/core.react.ColumnBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"}},c={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"backgroundColor",id:"backgroundcolor",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"backgroundColorSlug",id:"backgroundcolorslug",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"gradient",id:"gradient",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"gradientSlug",id:"gradientslug",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"linkColor",id:"linkcolor",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"linkColorSlug",id:"linkcolorslug",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"textColor",id:"textcolor",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"textColorSlug",id:"textcolorslug",level:3},{value:"Defined in",id:"defined-in-7",level:4}],p={toc:s};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".Colors"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Colors"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.BlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"BlockAttributes"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"backgroundcolor"},"backgroundColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"backgroundColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L6"},"packages/core/src/react/blocks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"backgroundcolorslug"},"backgroundColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"backgroundColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L5"},"packages/core/src/react/blocks/types.ts:5")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"gradient"},"gradient"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"gradient"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L8"},"packages/core/src/react/blocks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"gradientslug"},"gradientSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"gradientSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L7"},"packages/core/src/react/blocks/types.ts:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linkcolor"},"linkColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"linkColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L12"},"packages/core/src/react/blocks/types.ts:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linkcolorslug"},"linkColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"linkColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L11"},"packages/core/src/react/blocks/types.ts:11")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"textcolor"},"textColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"textColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L10"},"packages/core/src/react/blocks/types.ts:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"textcolorslug"},"textColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"textColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L9"},"packages/core/src/react/blocks/types.ts:9")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/01354409.9db09290.js b/assets/js/01354409.e867e768.js similarity index 95% rename from assets/js/01354409.9db09290.js rename to assets/js/01354409.e867e768.js index ee8b2f0f8..5dcdccf50 100644 --- a/assets/js/01354409.9db09290.js +++ b/assets/js/01354409.e867e768.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3021],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var o=a.createContext({}),s=function(e){var t=a.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},c=function(e){var t=s(e.components);return a.createElement(o.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},f=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),d=s(r),f=n,m=d["".concat(o,".").concat(f)]||d[f]||u[f]||i;return r?a.createElement(m,l(l({ref:t},c),{},{components:r})):a.createElement(m,l({ref:t},c))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=f;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[d]="string"==typeof e?e:n,l[1]=p;for(var s=2;s{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>p,toc:()=>s});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.AvatarUrls",title:"Interface: AvatarUrls",sidebar_label:"@headstartwp/core.AvatarUrls",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.AvatarUrls",id:"interfaces/headstartwp_core.AvatarUrls",title:"Interface: AvatarUrls",description:"@headstartwp/core.AvatarUrls",source:"@site/docs/interfaces/headstartwp_core.AvatarUrls.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.AvatarUrls",permalink:"/docs/api/interfaces/headstartwp_core.AvatarUrls",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AvatarUrls",title:"Interface: AvatarUrls",sidebar_label:"@headstartwp/core.AvatarUrls",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AuthorEntity",permalink:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},next:{title:"@headstartwp/core.CommentEntity",permalink:"/docs/api/interfaces/headstartwp_core.CommentEntity"}},o={},s=[{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"24",id:"24",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"48",id:"48",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"96",id:"96",level:3},{value:"Defined in",id:"defined-in-2",level:4}],c={toc:s};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AvatarUrls"),(0,n.kt)("p",null,"Map of avatar URLs by their size."),(0,n.kt)("h2",{id:"indexable"},"Indexable"),(0,n.kt)("p",null,"\u25aa ","[k: ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"24"},"24"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"24"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Avatar URL with image size of 24 pixels."),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L489"},"packages/core/src/data/types/entities.ts:489")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"48"},"48"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"48"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Avatar URL with image size of 48 pixels."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L494"},"packages/core/src/data/types/entities.ts:494")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"96"},"96"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"96"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Avatar URL with image size of 96 pixels."),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L499"},"packages/core/src/data/types/entities.ts:499")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3021],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var o=a.createContext({}),s=function(e){var t=a.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},c=function(e){var t=s(e.components);return a.createElement(o.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},f=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),d=s(r),f=n,m=d["".concat(o,".").concat(f)]||d[f]||u[f]||i;return r?a.createElement(m,l(l({ref:t},c),{},{components:r})):a.createElement(m,l({ref:t},c))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=f;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[d]="string"==typeof e?e:n,l[1]=p;for(var s=2;s{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>p,toc:()=>s});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.AvatarUrls",title:"Interface: AvatarUrls",sidebar_label:"@headstartwp/core.AvatarUrls",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.AvatarUrls",id:"interfaces/headstartwp_core.AvatarUrls",title:"Interface: AvatarUrls",description:"@headstartwp/core.AvatarUrls",source:"@site/docs/interfaces/headstartwp_core.AvatarUrls.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.AvatarUrls",permalink:"/docs/api/interfaces/headstartwp_core.AvatarUrls",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AvatarUrls",title:"Interface: AvatarUrls",sidebar_label:"@headstartwp/core.AvatarUrls",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AuthorEntity",permalink:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},next:{title:"@headstartwp/core.CommentEntity",permalink:"/docs/api/interfaces/headstartwp_core.CommentEntity"}},o={},s=[{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"24",id:"24",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"48",id:"48",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"96",id:"96",level:3},{value:"Defined in",id:"defined-in-2",level:4}],c={toc:s};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AvatarUrls"),(0,n.kt)("p",null,"Map of avatar URLs by their size."),(0,n.kt)("h2",{id:"indexable"},"Indexable"),(0,n.kt)("p",null,"\u25aa ","[k: ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"24"},"24"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"24"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Avatar URL with image size of 24 pixels."),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L489"},"packages/core/src/data/types/entities.ts:489")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"48"},"48"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"48"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Avatar URL with image size of 48 pixels."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L494"},"packages/core/src/data/types/entities.ts:494")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"96"},"96"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"96"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Avatar URL with image size of 96 pixels."),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L499"},"packages/core/src/data/types/entities.ts:499")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/016f03e8.b0c86872.js b/assets/js/016f03e8.47e0b40d.js similarity index 99% rename from assets/js/016f03e8.b0c86872.js rename to assets/js/016f03e8.47e0b40d.js index 085745182..f4e5268d0 100644 --- a/assets/js/016f03e8.b0c86872.js +++ b/assets/js/016f03e8.47e0b40d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2849],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=a.createContext({}),c=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=c(e.components);return a.createElement(l.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=c(n),h=i,m=u["".concat(l,".").concat(h)]||u[h]||d[h]||r;return n?a.createElement(m,o(o({ref:t},p),{},{components:n})):a.createElement(m,o({ref:t},p))}));function m(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,o=new Array(r);o[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[u]="string"==typeof e?e:i,o[1]=s;for(var c=2;c{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>c});var a=n(7462),i=(n(7294),n(3905));const r={sidebar_label:"A/B Test SPA vs MPA navigation",sidebar_position:0},o="A/B Testing SPA vs MPA navigation",s={unversionedId:"Guides/ab-test-link",id:"Guides/ab-test-link",title:"A/B Testing SPA vs MPA navigation",description:"In this guide, we\u2019ll implement a custom Link component that will replace every Link in the post content with a custom React component that will implement SPA or MPA navigation based on an A/B test. By \u201cSPA navigation\u201d I mean navigating to other pages via client-side rendering instead of a full-page reload. MPA navigation is the opposite and traditional way of navigation.",source:"@site/documentation/08-Guides/ab-test-link.md",sourceDirName:"08-Guides",slug:"/Guides/ab-test-link",permalink:"/docs/learn/Guides/ab-test-link",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/08-Guides/ab-test-link.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:0,frontMatter:{sidebar_label:"A/B Test SPA vs MPA navigation",sidebar_position:0},sidebar:"tutorialSidebar",previous:{title:"Polylang Integration",permalink:"/docs/learn/wordpress-integration/polylang"},next:{title:"Linaria (CSS-in-JS)",permalink:"/docs/learn/Guides/linaria"}},l={},c=[],p={toc:c};function u(e){let{components:t,...r}=e;return(0,i.kt)("wrapper",(0,a.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"ab-testing-spa-vs-mpa-navigation"},"A/B Testing SPA vs MPA navigation"),(0,i.kt)("p",null," In this guide, we\u2019ll implement a custom Link component that will replace every Link in the post content with a custom React component that will implement SPA or MPA navigation based on an A/B test. By \u201cSPA navigation\u201d I mean navigating to other pages via client-side rendering instead of a full-page reload. MPA navigation is the opposite and traditional way of navigation."),(0,i.kt)("p",null," This is an interesting use case since there are some claims that ",(0,i.kt)("a",{parentName:"p",href:"https://web.dev/vitals-spa-faq/"},"MPA might perform better in web vitals compared to SPA")," (not because it\u2019s necessarily better but because of difficulties to capture some metrics in SPA)."),(0,i.kt)("p",null," First off, let\u2019s create a custom LinkBlock. We\u2019ll replace the default LinkBlock component with a custom one. Note that the default LinkBlock is a special block implementation that handles internal links for Next.js."),(0,i.kt)("p",null," The starter project already has a custom ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/nicholasio/headless-tutorial/blob/trunk/src/components/Link.js"},"Link")," component that is passed via dependency injection to the Framework Provider in ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/nicholasio/headless-tutorial/blob/trunk/src/pages/_app.js#L38"},"_app.js"),". This is essentially telling the framework to use that component whenever rendering a Link."),(0,i.kt)("p",null,"So the next step here is creating our own \u201cLinkBlock\u201d implementation to use that custom link component."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"import { Link } from './Link';\n\nconst LinkBlock = ({ domNode, children }) => {\n const { href, rel } = getAttributes(domNode.attribs);\n\n return (\n \n {children}\n \n );\n};\n\nLinkBlock.propTypes = {\n domNode: PropTypes.shape({\n attribs: PropTypes.shape({}).isRequired,\n }).isRequired,\n children: PropTypes.node.isRequired,\n};\n")),(0,i.kt)("p",null,"Our custom LinkBlock component leverages the getAttributes utility that receives the domNode attributes and returns an object with available node attributes. You could access attributes directly but this function does some normalization especially around returning className instead of class."),(0,i.kt)("p",null,"We\u2019ll leverage Next.js middleware for A/B testing. If you\u2019re unfamiliar with Next.js middleware, go read their ",(0,i.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/advanced-features/middleware"},"documentation"),"."),(0,i.kt)("p",null,"The next step is to open ",(0,i.kt)("inlineCode",{parentName:"p"},"src/middleware.js")," and make the following changes:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"import { AppMiddleware } from '@headstartwp/next/middlewares';\nimport { NextResponse } from 'next/server';\n\nconst COOKIE_NAME = 'bucket-navigation';\nconst BUCKETS = ['spa', 'mpa'];\nconst getBucket = () => BUCKETS[Math.floor(Math.random() * BUCKETS.length)];\n\nexport async function middleware(req) {\n const response = await AppMiddleware(req);\n\n if (!response.redirected) {\n const url = req.nextUrl;\n const bucket = req.cookies.get(COOKIE_NAME) || getBucket();\n\n response.cookies.set(COOKIE_NAME, bucket);\n url.searchParams.set('navigation', bucket);\n\n req.nextUrl.searchParams.set('navigation', bucket);\n return NextResponse.rewrite(req.nextUrl, response);\n }\n\n return response;\n}\n")),(0,i.kt)("p",null,"Here, we\u2019re simply simulating an A/B test, but you could, in theory, replace getBucket with a call to an A/B testing service. This middleware is essentially adding ?navigation=type to every URL using rewrite which means users won\u2019t actually see that query param in the URL. That provides us with an easy way to check if the current request should be using SPA or MPA for navigation which we\u2019ll do directly in the Link component."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"// src/components/Link.js\nexport const Link = ({ href, rel, children }) => {\n const { query } = useRouter();\n\n const settings = useSettings();\n const link = removeSourceUrl({ link: href, backendUrl: settings.sourceUrl || '' });\n\n const isSpaNavigation = query?.navigation === 'spa' || typeof query.navigation === 'undefined';\n\n if (isSpaNavigation) {\n return (\n \n {/* eslint-disable-next-line jsx-a11y/anchor-is-valid */}\n {children}\n \n );\n }\n\n return (\n \n {children}\n \n );\n};\n")),(0,i.kt)("p",null,"The changes to this component limit to checking the query object from the router and if the navigation param is equal to \u201cspa\u201d or undefined, in which case it will default to use the Next.js Link component. Otherwise, it defaults to an MPA by simply rendering a regular anchor tag."),(0,i.kt)("p",null,"Note that the link is converted to a relative link to remove the WordPress domain."),(0,i.kt)("p",null,"To test this, open a page. Then, check which bucket you\u2019re in"),(0,i.kt)("p",null,(0,i.kt)("img",{alt:"AB Test bucket",src:n(877).Z,width:"1024",height:"251"})),(0,i.kt)("p",null,"In the example above, I was assigned the \u201cmpa\u201d bucket I should see a full page reload when navigating to internal links inside the post content. You can change to the \u201cspa\u201d bucket by modifying the cookie."),(0,i.kt)("p",null,(0,i.kt)("img",{alt:"AB Test Link",src:n(4376).Z,width:"1444",height:"930"})))}u.isMDXComponent=!0},877:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/a-b-test-1-b1409857b5f72e1a97ec053cc775846f.png"},4376:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/a-b-testing-link-c71624b493baae52089d5258aeb43246.gif"}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2849],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=a.createContext({}),c=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=c(e.components);return a.createElement(l.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=c(n),h=i,m=u["".concat(l,".").concat(h)]||u[h]||d[h]||r;return n?a.createElement(m,o(o({ref:t},p),{},{components:n})):a.createElement(m,o({ref:t},p))}));function m(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,o=new Array(r);o[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[u]="string"==typeof e?e:i,o[1]=s;for(var c=2;c{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>c});var a=n(7462),i=(n(7294),n(3905));const r={sidebar_label:"A/B Test SPA vs MPA navigation",sidebar_position:0},o="A/B Testing SPA vs MPA navigation",s={unversionedId:"Guides/ab-test-link",id:"Guides/ab-test-link",title:"A/B Testing SPA vs MPA navigation",description:"In this guide, we\u2019ll implement a custom Link component that will replace every Link in the post content with a custom React component that will implement SPA or MPA navigation based on an A/B test. By \u201cSPA navigation\u201d I mean navigating to other pages via client-side rendering instead of a full-page reload. MPA navigation is the opposite and traditional way of navigation.",source:"@site/documentation/08-Guides/ab-test-link.md",sourceDirName:"08-Guides",slug:"/Guides/ab-test-link",permalink:"/docs/learn/Guides/ab-test-link",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/08-Guides/ab-test-link.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:0,frontMatter:{sidebar_label:"A/B Test SPA vs MPA navigation",sidebar_position:0},sidebar:"tutorialSidebar",previous:{title:"Polylang Integration",permalink:"/docs/learn/wordpress-integration/polylang"},next:{title:"Linaria (CSS-in-JS)",permalink:"/docs/learn/Guides/linaria"}},l={},c=[],p={toc:c};function u(e){let{components:t,...r}=e;return(0,i.kt)("wrapper",(0,a.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"ab-testing-spa-vs-mpa-navigation"},"A/B Testing SPA vs MPA navigation"),(0,i.kt)("p",null," In this guide, we\u2019ll implement a custom Link component that will replace every Link in the post content with a custom React component that will implement SPA or MPA navigation based on an A/B test. By \u201cSPA navigation\u201d I mean navigating to other pages via client-side rendering instead of a full-page reload. MPA navigation is the opposite and traditional way of navigation."),(0,i.kt)("p",null," This is an interesting use case since there are some claims that ",(0,i.kt)("a",{parentName:"p",href:"https://web.dev/vitals-spa-faq/"},"MPA might perform better in web vitals compared to SPA")," (not because it\u2019s necessarily better but because of difficulties to capture some metrics in SPA)."),(0,i.kt)("p",null," First off, let\u2019s create a custom LinkBlock. We\u2019ll replace the default LinkBlock component with a custom one. Note that the default LinkBlock is a special block implementation that handles internal links for Next.js."),(0,i.kt)("p",null," The starter project already has a custom ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/nicholasio/headless-tutorial/blob/trunk/src/components/Link.js"},"Link")," component that is passed via dependency injection to the Framework Provider in ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/nicholasio/headless-tutorial/blob/trunk/src/pages/_app.js#L38"},"_app.js"),". This is essentially telling the framework to use that component whenever rendering a Link."),(0,i.kt)("p",null,"So the next step here is creating our own \u201cLinkBlock\u201d implementation to use that custom link component."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"import { Link } from './Link';\n\nconst LinkBlock = ({ domNode, children }) => {\n const { href, rel } = getAttributes(domNode.attribs);\n\n return (\n \n {children}\n \n );\n};\n\nLinkBlock.propTypes = {\n domNode: PropTypes.shape({\n attribs: PropTypes.shape({}).isRequired,\n }).isRequired,\n children: PropTypes.node.isRequired,\n};\n")),(0,i.kt)("p",null,"Our custom LinkBlock component leverages the getAttributes utility that receives the domNode attributes and returns an object with available node attributes. You could access attributes directly but this function does some normalization especially around returning className instead of class."),(0,i.kt)("p",null,"We\u2019ll leverage Next.js middleware for A/B testing. If you\u2019re unfamiliar with Next.js middleware, go read their ",(0,i.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/advanced-features/middleware"},"documentation"),"."),(0,i.kt)("p",null,"The next step is to open ",(0,i.kt)("inlineCode",{parentName:"p"},"src/middleware.js")," and make the following changes:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"import { AppMiddleware } from '@headstartwp/next/middlewares';\nimport { NextResponse } from 'next/server';\n\nconst COOKIE_NAME = 'bucket-navigation';\nconst BUCKETS = ['spa', 'mpa'];\nconst getBucket = () => BUCKETS[Math.floor(Math.random() * BUCKETS.length)];\n\nexport async function middleware(req) {\n const response = await AppMiddleware(req);\n\n if (!response.redirected) {\n const url = req.nextUrl;\n const bucket = req.cookies.get(COOKIE_NAME) || getBucket();\n\n response.cookies.set(COOKIE_NAME, bucket);\n url.searchParams.set('navigation', bucket);\n\n req.nextUrl.searchParams.set('navigation', bucket);\n return NextResponse.rewrite(req.nextUrl, response);\n }\n\n return response;\n}\n")),(0,i.kt)("p",null,"Here, we\u2019re simply simulating an A/B test, but you could, in theory, replace getBucket with a call to an A/B testing service. This middleware is essentially adding ?navigation=type to every URL using rewrite which means users won\u2019t actually see that query param in the URL. That provides us with an easy way to check if the current request should be using SPA or MPA for navigation which we\u2019ll do directly in the Link component."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"// src/components/Link.js\nexport const Link = ({ href, rel, children }) => {\n const { query } = useRouter();\n\n const settings = useSettings();\n const link = removeSourceUrl({ link: href, backendUrl: settings.sourceUrl || '' });\n\n const isSpaNavigation = query?.navigation === 'spa' || typeof query.navigation === 'undefined';\n\n if (isSpaNavigation) {\n return (\n \n {/* eslint-disable-next-line jsx-a11y/anchor-is-valid */}\n {children}\n \n );\n }\n\n return (\n \n {children}\n \n );\n};\n")),(0,i.kt)("p",null,"The changes to this component limit to checking the query object from the router and if the navigation param is equal to \u201cspa\u201d or undefined, in which case it will default to use the Next.js Link component. Otherwise, it defaults to an MPA by simply rendering a regular anchor tag."),(0,i.kt)("p",null,"Note that the link is converted to a relative link to remove the WordPress domain."),(0,i.kt)("p",null,"To test this, open a page. Then, check which bucket you\u2019re in"),(0,i.kt)("p",null,(0,i.kt)("img",{alt:"AB Test bucket",src:n(877).Z,width:"1024",height:"251"})),(0,i.kt)("p",null,"In the example above, I was assigned the \u201cmpa\u201d bucket I should see a full page reload when navigating to internal links inside the post content. You can change to the \u201cspa\u201d bucket by modifying the cookie."),(0,i.kt)("p",null,(0,i.kt)("img",{alt:"AB Test Link",src:n(4376).Z,width:"1444",height:"930"})))}u.isMDXComponent=!0},877:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/a-b-test-1-b1409857b5f72e1a97ec053cc775846f.png"},4376:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/a-b-testing-link-c71624b493baae52089d5258aeb43246.gif"}}]); \ No newline at end of file diff --git a/assets/js/042474ac.13dd2180.js b/assets/js/042474ac.6372197f.js similarity index 92% rename from assets/js/042474ac.13dd2180.js rename to assets/js/042474ac.6372197f.js index 9cdbd641d..8292282c3 100644 --- a/assets/js/042474ac.13dd2180.js +++ b/assets/js/042474ac.6372197f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[669],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),k=n,h=s["".concat(p,".").concat(k)]||s[k]||m[k]||o;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=k;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.IPreformattedBlock",title:"Interface: IPreformattedBlock",sidebar_label:"@headstartwp/core.react.IPreformattedBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IPreformattedBlock",id:"interfaces/headstartwp_core.react.IPreformattedBlock",title:"Interface: IPreformattedBlock",description:"@headstartwp/core.react.IPreformattedBlock",source:"@site/docs/interfaces/headstartwp_core.react.IPreformattedBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IPreformattedBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IPreformattedBlock",title:"Interface: IPreformattedBlock",sidebar_label:"@headstartwp/core.react.IPreformattedBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IParagraphBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock"},next:{title:"@headstartwp/core.react.IPullQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IPreformattedBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PreformattedBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IPreformattedBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PreformattedBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PreformattedBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[669],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),d=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),s=d(a),k=n,h=s["".concat(p,".").concat(k)]||s[k]||m[k]||o;return a?r.createElement(h,l(l({ref:t},c),{},{components:a})):r.createElement(h,l({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=k;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.IPreformattedBlock",title:"Interface: IPreformattedBlock",sidebar_label:"@headstartwp/core.react.IPreformattedBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IPreformattedBlock",id:"interfaces/headstartwp_core.react.IPreformattedBlock",title:"Interface: IPreformattedBlock",description:"@headstartwp/core.react.IPreformattedBlock",source:"@site/docs/interfaces/headstartwp_core.react.IPreformattedBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IPreformattedBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IPreformattedBlock",title:"Interface: IPreformattedBlock",sidebar_label:"@headstartwp/core.react.IPreformattedBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IParagraphBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock"},next:{title:"@headstartwp/core.react.IPullQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IPreformattedBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PreformattedBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IPreformattedBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PreformattedBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PreformattedBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/09026ff1.b11d3066.js b/assets/js/09026ff1.c0799e18.js similarity index 96% rename from assets/js/09026ff1.b11d3066.js rename to assets/js/09026ff1.c0799e18.js index b4cf8d4c2..628e84603 100644 --- a/assets/js/09026ff1.b11d3066.js +++ b/assets/js/09026ff1.c0799e18.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5665],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var i=a.createContext({}),c=function(e){var t=a.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},l=function(e){var t=c(e.components);return a.createElement(i.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,i=e.parentName,l=p(e,["components","mdxType","originalType","parentName"]),d=c(r),k=n,f=d["".concat(i,".").concat(k)]||d[k]||u[k]||o;return r?a.createElement(f,s(s({ref:t},l),{},{components:r})):a.createElement(f,s({ref:t},l))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=k;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p[d]="string"==typeof e?e:n,s[1]=p;for(var c=2;c{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>p,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.HookResponse",title:"Interface: HookResponse",sidebar_label:"@headstartwp/core.react.HookResponse",custom_edit_url:null},s=void 0,p={unversionedId:"interfaces/headstartwp_core.react.HookResponse",id:"interfaces/headstartwp_core.react.HookResponse",title:"Interface: HookResponse",description:"@headstartwp/core.react.HookResponse",source:"@site/docs/interfaces/headstartwp_core.react.HookResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.HookResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.HookResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.HookResponse",title:"Interface: HookResponse",sidebar_label:"@headstartwp/core.react.HookResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.HeadingBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},next:{title:"@headstartwp/core.react.HtmlDecodeProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps"}},i={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Defined in",id:"defined-in-3",level:4}],l={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".HookResponse"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"usePostResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"usePostsResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"useSearchResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"useTermsResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"useAppSettingsResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"useMenuResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"usePostOrPostResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L5"},"packages/core/src/react/hooks/types.ts:5")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5665],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var i=a.createContext({}),c=function(e){var t=a.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},l=function(e){var t=c(e.components);return a.createElement(i.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,i=e.parentName,l=p(e,["components","mdxType","originalType","parentName"]),d=c(r),k=n,f=d["".concat(i,".").concat(k)]||d[k]||u[k]||o;return r?a.createElement(f,s(s({ref:t},l),{},{components:r})):a.createElement(f,s({ref:t},l))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=k;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p[d]="string"==typeof e?e:n,s[1]=p;for(var c=2;c{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>p,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.HookResponse",title:"Interface: HookResponse",sidebar_label:"@headstartwp/core.react.HookResponse",custom_edit_url:null},s=void 0,p={unversionedId:"interfaces/headstartwp_core.react.HookResponse",id:"interfaces/headstartwp_core.react.HookResponse",title:"Interface: HookResponse",description:"@headstartwp/core.react.HookResponse",source:"@site/docs/interfaces/headstartwp_core.react.HookResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.HookResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.HookResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.HookResponse",title:"Interface: HookResponse",sidebar_label:"@headstartwp/core.react.HookResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.HeadingBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},next:{title:"@headstartwp/core.react.HtmlDecodeProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps"}},i={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Defined in",id:"defined-in-3",level:4}],l={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".HookResponse"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"usePostResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"usePostsResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"useSearchResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"useTermsResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"useAppSettingsResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"useMenuResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"usePostOrPostResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L5"},"packages/core/src/react/hooks/types.ts:5")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/09153873.b51dab69.js b/assets/js/09153873.04c9fc14.js similarity index 93% rename from assets/js/09153873.b51dab69.js rename to assets/js/09153873.04c9fc14.js index d528c7669..1b0b31a97 100644 --- a/assets/js/09153873.b51dab69.js +++ b/assets/js/09153873.04c9fc14.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3182],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function s(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),d=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):s(s({},t),e)),a},o=function(e){var t=d(e.components);return n.createElement(p.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),c=d(a),u=r,k=c["".concat(p,".").concat(u)]||c[u]||h[u]||i;return a?n.createElement(k,s(s({ref:t},o),{},{components:a})):n.createElement(k,s({ref:t},o))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,s=new Array(i);s[0]=u;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[c]="string"==typeof e?e:r,s[1]=l;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.PostsArchiveParams",title:"Interface: PostsArchiveParams",sidebar_label:"@headstartwp/core.PostsArchiveParams",custom_edit_url:null},s=void 0,l={unversionedId:"interfaces/headstartwp_core.PostsArchiveParams",id:"interfaces/headstartwp_core.PostsArchiveParams",title:"Interface: PostsArchiveParams",description:"@headstartwp/core.PostsArchiveParams",source:"@site/docs/interfaces/headstartwp_core.PostsArchiveParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PostsArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostsArchiveParams",title:"Interface: PostsArchiveParams",sidebar_label:"@headstartwp/core.PostsArchiveParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostTypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},next:{title:"@headstartwp/core.Rendered",permalink:"/docs/api/interfaces/headstartwp_core.Rendered"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"author",id:"author",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"author_exclude",id:"author_exclude",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"categories",id:"categories",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"categories_exclude",id:"categories_exclude",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"category",id:"category",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"day",id:"day",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"exclude",id:"exclude",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"include",id:"include",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"lang",id:"lang",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"matchArchivePath",id:"matcharchivepath",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"month",id:"month",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"offset",id:"offset",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"order",id:"order",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"orderby",id:"orderby",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"page",id:"page",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"per_page",id:"per_page",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"postType",id:"posttype",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"search",id:"search",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"sticky",id:"sticky",level:3},{value:"Defined in",id:"defined-in-22",level:4},{value:"tag",id:"tag",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"tags",id:"tags",level:3},{value:"Defined in",id:"defined-in-24",level:4},{value:"tags_exclude",id:"tags_exclude",level:3},{value:"Defined in",id:"defined-in-25",level:4},{value:"tax_relation",id:"tax_relation",level:3},{value:"Defined in",id:"defined-in-26",level:4},{value:"taxonomy",id:"taxonomy",level:3},{value:"Defined in",id:"defined-in-27",level:4},{value:"year",id:"year",level:3},{value:"Defined in",id:"defined-in-28",level:4}],o={toc:d};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostsArchiveParams"),(0,r.kt)("p",null,"The EndpointParams supported by the ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy")),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,r.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"PostsArchiveParams"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"_embed"},"_","embed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"The _embed param returned associated entities in the response"),(0,r.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_embed"},"_embed")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_fields"},"_","fields"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_fields"},"_fields")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author"},"author"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"author"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to posts assigned to specific authors."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L83"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:83")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author_exclude"},"author","_","exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"author","_","exclude"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Ensure result set excludes posts assigned to specific authors."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L88"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:88")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"categories"},"categories"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"categories"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[] ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to all items that have the specified term assigned in the categories taxonomy."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L156"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:156")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"categories_exclude"},"categories","_","exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"categories","_","exclude"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to all items except those that have the specified term assigned in the categories taxonomy."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L161"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:161")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"category"},"category"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"category"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"If set will filter results by the specified category name"),(0,r.kt)("p",null,"It supports both a category id and category slug"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L44"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:44")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"day"},"day"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"day"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"If set will filter results by the specified day"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L66"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Ensure result set excludes specific IDs."),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L93"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:93")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"include"},"include"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"include"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to specific IDs."),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L98"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:98")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"lang"},"lang"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"lang"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The polylang ?lang parameter."),(0,r.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#lang"},"lang")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"matcharchivepath"},"matchArchivePath"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"matchArchivePath"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Overrides the value set in CustomTaxonomy#matchArchivePath"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"false"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L190"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:190")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"month"},"month"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"month"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"If set will filter results by the specified month"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L61"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:61")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"offset"},"offset"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"offset"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Offset the result set by a specific number of items."),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L103"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:103")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"order"},"order"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"order"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"asc"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"desc"')),(0,r.kt)("p",null,"Order sort attribute ascending or descending."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'desc'"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L110"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:110")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"orderby"},"orderby"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"orderby"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"slug"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"date"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"modified"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"id"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"title"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"author"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"parent"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"include"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"relevance"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"include_slugs"')),(0,r.kt)("p",null,"Sort collection by object attribute."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'date'"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L129"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:129")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"page"},"page"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"page"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Current page of the collection."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"1"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L37"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:37")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"per_page"},"per","_","page"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"per","_","page"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Maximum number of items to be returned in result set."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"10"),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L73"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:73")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"posttype"},"postType"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"postType"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The post type to query for."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'post'"),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L117"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:117")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"search"},"search"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"search"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Limit results to those matching a string."),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L78"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:78")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Limit result set to posts with one or more specific slugs."),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L122"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:122")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"status"},"status"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Limit result set to posts assigned one or more statuses."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'publish'"),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L146"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:146")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sticky"},"sticky"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"sticky"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Limit result set to items that are sticky."),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L183"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:183")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tag"},"tag"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tag"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"If set will filter results by the specified tag name"),(0,r.kt)("p",null,"It supports both a category id and category slug"),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L51"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:51")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tags"},"tags"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tags"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[] ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to all items that have the specified term assigned in the tags taxonomy."),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L173"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:173")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tags_exclude"},"tags","_","exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tags","_","exclude"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to all items except those that have the specified term assigned in the tags taxonomy."),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L178"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:178")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tax_relation"},"tax","_","relation"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tax","_","relation"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"AND"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"OR"')),(0,r.kt)("p",null,"Limit result set based on relationship between multiple taxonomies."),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L151"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:151")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"taxonomy"},"taxonomy"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"taxonomy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Limit results to a specific taxonomy and expects the actual term slug to come from the url]"),(0,r.kt)("p",null,"If you only specify the taxonomy, the term slug will be assumed to be the first segment of the path"),(0,r.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L168"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:168")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"year"},"year"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"year"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"If set will filter results by the specified year"),(0,r.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L56"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:56")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3182],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function s(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),d=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):s(s({},t),e)),a},o=function(e){var t=d(e.components);return n.createElement(p.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),c=d(a),u=r,k=c["".concat(p,".").concat(u)]||c[u]||h[u]||i;return a?n.createElement(k,s(s({ref:t},o),{},{components:a})):n.createElement(k,s({ref:t},o))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,s=new Array(i);s[0]=u;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[c]="string"==typeof e?e:r,s[1]=l;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.PostsArchiveParams",title:"Interface: PostsArchiveParams",sidebar_label:"@headstartwp/core.PostsArchiveParams",custom_edit_url:null},s=void 0,l={unversionedId:"interfaces/headstartwp_core.PostsArchiveParams",id:"interfaces/headstartwp_core.PostsArchiveParams",title:"Interface: PostsArchiveParams",description:"@headstartwp/core.PostsArchiveParams",source:"@site/docs/interfaces/headstartwp_core.PostsArchiveParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PostsArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostsArchiveParams",title:"Interface: PostsArchiveParams",sidebar_label:"@headstartwp/core.PostsArchiveParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostTypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},next:{title:"@headstartwp/core.Rendered",permalink:"/docs/api/interfaces/headstartwp_core.Rendered"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"author",id:"author",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"author_exclude",id:"author_exclude",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"categories",id:"categories",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"categories_exclude",id:"categories_exclude",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"category",id:"category",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"day",id:"day",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"exclude",id:"exclude",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"include",id:"include",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"lang",id:"lang",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"matchArchivePath",id:"matcharchivepath",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"month",id:"month",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"offset",id:"offset",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"order",id:"order",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"orderby",id:"orderby",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"page",id:"page",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"per_page",id:"per_page",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"postType",id:"posttype",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"search",id:"search",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"sticky",id:"sticky",level:3},{value:"Defined in",id:"defined-in-22",level:4},{value:"tag",id:"tag",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"tags",id:"tags",level:3},{value:"Defined in",id:"defined-in-24",level:4},{value:"tags_exclude",id:"tags_exclude",level:3},{value:"Defined in",id:"defined-in-25",level:4},{value:"tax_relation",id:"tax_relation",level:3},{value:"Defined in",id:"defined-in-26",level:4},{value:"taxonomy",id:"taxonomy",level:3},{value:"Defined in",id:"defined-in-27",level:4},{value:"year",id:"year",level:3},{value:"Defined in",id:"defined-in-28",level:4}],o={toc:d};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostsArchiveParams"),(0,r.kt)("p",null,"The EndpointParams supported by the ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy")),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,r.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"PostsArchiveParams"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"_embed"},"_","embed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"The _embed param returned associated entities in the response"),(0,r.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_embed"},"_embed")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_fields"},"_","fields"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_fields"},"_fields")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author"},"author"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"author"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to posts assigned to specific authors."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L83"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:83")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author_exclude"},"author","_","exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"author","_","exclude"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Ensure result set excludes posts assigned to specific authors."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L88"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:88")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"categories"},"categories"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"categories"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[] ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to all items that have the specified term assigned in the categories taxonomy."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L156"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:156")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"categories_exclude"},"categories","_","exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"categories","_","exclude"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to all items except those that have the specified term assigned in the categories taxonomy."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L161"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:161")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"category"},"category"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"category"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"If set will filter results by the specified category name"),(0,r.kt)("p",null,"It supports both a category id and category slug"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L44"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:44")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"day"},"day"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"day"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"If set will filter results by the specified day"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L66"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Ensure result set excludes specific IDs."),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L93"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:93")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"include"},"include"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"include"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to specific IDs."),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L98"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:98")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"lang"},"lang"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"lang"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The polylang ?lang parameter."),(0,r.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#lang"},"lang")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"matcharchivepath"},"matchArchivePath"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"matchArchivePath"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Overrides the value set in CustomTaxonomy#matchArchivePath"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"false"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L190"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:190")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"month"},"month"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"month"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"If set will filter results by the specified month"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L61"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:61")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"offset"},"offset"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"offset"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Offset the result set by a specific number of items."),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L103"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:103")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"order"},"order"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"order"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"asc"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"desc"')),(0,r.kt)("p",null,"Order sort attribute ascending or descending."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'desc'"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L110"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:110")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"orderby"},"orderby"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"orderby"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"slug"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"date"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"modified"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"id"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"title"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"author"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"parent"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"include"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"relevance"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"include_slugs"')),(0,r.kt)("p",null,"Sort collection by object attribute."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'date'"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L129"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:129")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"page"},"page"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"page"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Current page of the collection."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"1"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L37"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:37")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"per_page"},"per","_","page"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"per","_","page"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Maximum number of items to be returned in result set."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"10"),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L73"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:73")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"posttype"},"postType"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"postType"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The post type to query for."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'post'"),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L117"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:117")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"search"},"search"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"search"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Limit results to those matching a string."),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L78"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:78")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Limit result set to posts with one or more specific slugs."),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L122"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:122")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"status"},"status"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Limit result set to posts assigned one or more statuses."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'publish'"),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L146"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:146")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sticky"},"sticky"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"sticky"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Limit result set to items that are sticky."),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L183"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:183")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tag"},"tag"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tag"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"If set will filter results by the specified tag name"),(0,r.kt)("p",null,"It supports both a category id and category slug"),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L51"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:51")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tags"},"tags"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tags"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[] ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to all items that have the specified term assigned in the tags taxonomy."),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L173"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:173")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tags_exclude"},"tags","_","exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tags","_","exclude"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to all items except those that have the specified term assigned in the tags taxonomy."),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L178"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:178")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tax_relation"},"tax","_","relation"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tax","_","relation"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"AND"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"OR"')),(0,r.kt)("p",null,"Limit result set based on relationship between multiple taxonomies."),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L151"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:151")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"taxonomy"},"taxonomy"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"taxonomy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Limit results to a specific taxonomy and expects the actual term slug to come from the url]"),(0,r.kt)("p",null,"If you only specify the taxonomy, the term slug will be assumed to be the first segment of the path"),(0,r.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L168"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:168")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"year"},"year"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"year"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"If set will filter results by the specified year"),(0,r.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L56"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:56")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/0a88c552.7ed47567.js b/assets/js/0a88c552.21c42dfd.js similarity index 94% rename from assets/js/0a88c552.7ed47567.js rename to assets/js/0a88c552.21c42dfd.js index 7baa8c1eb..6e36587ba 100644 --- a/assets/js/0a88c552.7ed47567.js +++ b/assets/js/0a88c552.21c42dfd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1701],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>k});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var l=n.createContext({}),o=function(e){var t=n.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},d=function(e){var t=o(e.components);return n.createElement(l.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,l=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),c=o(a),u=r,k=c["".concat(l,".").concat(u)]||c[u]||m[u]||i;return a?n.createElement(k,p(p({ref:t},d),{},{components:a})):n.createElement(k,p({ref:t},d))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=u;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[c]="string"==typeof e?e:r,p[1]=s;for(var o=2;o{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>o});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.TaxonomyArchiveParams",title:"Interface: TaxonomyArchiveParams",sidebar_label:"@headstartwp/core.TaxonomyArchiveParams",custom_edit_url:null},p=void 0,s={unversionedId:"interfaces/headstartwp_core.TaxonomyArchiveParams",id:"interfaces/headstartwp_core.TaxonomyArchiveParams",title:"Interface: TaxonomyArchiveParams",description:"@headstartwp/core.TaxonomyArchiveParams",source:"@site/docs/interfaces/headstartwp_core.TaxonomyArchiveParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.TaxonomyArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.TaxonomyArchiveParams",title:"Interface: TaxonomyArchiveParams",sidebar_label:"@headstartwp/core.TaxonomyArchiveParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.SearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.SearchEntity"},next:{title:"@headstartwp/core.TaxonomyEntity",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyEntity"}},l={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"exclude",id:"exclude",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"hide_empty",id:"hide_empty",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"include",id:"include",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"lang",id:"lang",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"order",id:"order",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"orderby",id:"orderby",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"page",id:"page",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"parent",id:"parent",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"per_page",id:"per_page",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"post",id:"post",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"search",id:"search",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"taxonomy",id:"taxonomy",level:3},{value:"Defined in",id:"defined-in-14",level:4}],d={toc:o};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".TaxonomyArchiveParams"),(0,r.kt)("p",null,"The endpoint params supported by ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy"},"TaxonomyTermsStrategy")),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,r.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"TaxonomyArchiveParams"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"_embed"},"_","embed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"The _embed param returned associated entities in the response"),(0,r.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_embed"},"_embed")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_fields"},"_","fields"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_fields"},"_fields")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Ensure result set excludes specific IDs."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L49"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:49")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hide_empty"},"hide","_","empty"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"hide","_","empty"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Whether to hide terms not assigned to any posts."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L76"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:76")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"include"},"include"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"include"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to specific IDs."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L44"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:44")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"lang"},"lang"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"lang"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The polylang ?lang parameter."),(0,r.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#lang"},"lang")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"order"},"order"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"order"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"asc"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"desc"')),(0,r.kt)("p",null,"Order sort attribute ascending or descending."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'asc'"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L56"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:56")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"orderby"},"orderby"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"orderby"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"slug"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"id"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"description"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"name"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"count"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"include"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"include_slugs"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"term_group"')),(0,r.kt)("p",null,"Sort collection by term attribute."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'name'"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L63"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:63")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"page"},"page"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"page"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Current page of the collection."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"1"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L27"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parent"},"parent"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"parent"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Limit result set to terms assigned to a specific parent."),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L81"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:81")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"per_page"},"per","_","page"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"per","_","page"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Maximum number of items to be returned in result set."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"10"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L34"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:34")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"post"},"post"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"post"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Limit result set to terms assigned to a specific post."),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L86"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:86")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"search"},"search"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"search"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Limit results to those matching a string"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L39"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:39")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Limit result set to terms with one or more specific slugs."),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L91"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:91")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"taxonomy"},"taxonomy"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"taxonomy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The taxonomy the terms are to be fetched from."),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L20"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:20")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1701],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>k});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var l=n.createContext({}),o=function(e){var t=n.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},d=function(e){var t=o(e.components);return n.createElement(l.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,l=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),c=o(a),u=r,k=c["".concat(l,".").concat(u)]||c[u]||m[u]||i;return a?n.createElement(k,p(p({ref:t},d),{},{components:a})):n.createElement(k,p({ref:t},d))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=u;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[c]="string"==typeof e?e:r,p[1]=s;for(var o=2;o{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>o});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.TaxonomyArchiveParams",title:"Interface: TaxonomyArchiveParams",sidebar_label:"@headstartwp/core.TaxonomyArchiveParams",custom_edit_url:null},p=void 0,s={unversionedId:"interfaces/headstartwp_core.TaxonomyArchiveParams",id:"interfaces/headstartwp_core.TaxonomyArchiveParams",title:"Interface: TaxonomyArchiveParams",description:"@headstartwp/core.TaxonomyArchiveParams",source:"@site/docs/interfaces/headstartwp_core.TaxonomyArchiveParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.TaxonomyArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.TaxonomyArchiveParams",title:"Interface: TaxonomyArchiveParams",sidebar_label:"@headstartwp/core.TaxonomyArchiveParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.SearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.SearchEntity"},next:{title:"@headstartwp/core.TaxonomyEntity",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyEntity"}},l={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"exclude",id:"exclude",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"hide_empty",id:"hide_empty",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"include",id:"include",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"lang",id:"lang",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"order",id:"order",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"orderby",id:"orderby",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"page",id:"page",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"parent",id:"parent",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"per_page",id:"per_page",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"post",id:"post",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"search",id:"search",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"taxonomy",id:"taxonomy",level:3},{value:"Defined in",id:"defined-in-14",level:4}],d={toc:o};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".TaxonomyArchiveParams"),(0,r.kt)("p",null,"The endpoint params supported by ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy"},"TaxonomyTermsStrategy")),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,r.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"TaxonomyArchiveParams"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"_embed"},"_","embed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"The _embed param returned associated entities in the response"),(0,r.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_embed"},"_embed")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_fields"},"_","fields"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_fields"},"_fields")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Ensure result set excludes specific IDs."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L49"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:49")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hide_empty"},"hide","_","empty"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"hide","_","empty"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Whether to hide terms not assigned to any posts."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L76"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:76")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"include"},"include"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"include"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to specific IDs."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L44"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:44")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"lang"},"lang"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"lang"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The polylang ?lang parameter."),(0,r.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#lang"},"lang")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"order"},"order"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"order"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"asc"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"desc"')),(0,r.kt)("p",null,"Order sort attribute ascending or descending."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'asc'"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L56"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:56")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"orderby"},"orderby"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"orderby"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"slug"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"id"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"description"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"name"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"count"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"include"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"include_slugs"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"term_group"')),(0,r.kt)("p",null,"Sort collection by term attribute."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'name'"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L63"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:63")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"page"},"page"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"page"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Current page of the collection."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"1"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L27"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parent"},"parent"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"parent"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Limit result set to terms assigned to a specific parent."),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L81"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:81")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"per_page"},"per","_","page"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"per","_","page"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Maximum number of items to be returned in result set."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"10"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L34"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:34")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"post"},"post"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"post"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Limit result set to terms assigned to a specific post."),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L86"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:86")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"search"},"search"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"search"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Limit results to those matching a string"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L39"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:39")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Limit result set to terms with one or more specific slugs."),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L91"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:91")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"taxonomy"},"taxonomy"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"taxonomy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The taxonomy the terms are to be fetched from."),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L20"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:20")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/0dbccef1.ea605ee3.js b/assets/js/0dbccef1.1c1afe51.js similarity index 96% rename from assets/js/0dbccef1.ea605ee3.js rename to assets/js/0dbccef1.1c1afe51.js index c7392530c..cd0a90f18 100644 --- a/assets/js/0dbccef1.ea605ee3.js +++ b/assets/js/0dbccef1.1c1afe51.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2925],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>u});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var d=n.createContext({}),o=function(e){var t=n.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},s=function(e){var t=o(e.components);return n.createElement(d.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},N=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),m=o(a),N=r,u=m["".concat(d,".").concat(N)]||m[N]||k[N]||i;return a?n.createElement(u,l(l({ref:t},s),{},{components:a})):n.createElement(u,l({ref:t},s))}));function u(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,l=new Array(i);l[0]=N;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p[m]="string"==typeof e?e:r,l[1]=p;for(var o=2;o{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>m,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core",title:"Module: @headstartwp/core",sidebar_label:"@headstartwp/core",sidebar_position:0,custom_edit_url:null},l=void 0,p={unversionedId:"modules/headstartwp_core",id:"modules/headstartwp_core",title:"Module: @headstartwp/core",description:"Namespaces",source:"@site/docs/modules/headstartwp_core.md",sourceDirName:"modules",slug:"/modules/headstartwp_core",permalink:"/docs/api/modules/headstartwp_core",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"headstartwp_core",title:"Module: @headstartwp/core",sidebar_label:"@headstartwp/core",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Table of Contents",permalink:"/docs/api/"},next:{title:"@headstartwp/next",permalink:"/docs/api/modules/headstartwp_next"}},d={},o=[{value:"Namespaces",id:"namespaces",level:2},{value:"Enumerations",id:"enumerations",level:2},{value:"Classes",id:"classes",level:2},{value:"Interfaces",id:"interfaces",level:2},{value:"DOM Helpers",id:"dom-helpers",level:2},{value:"isAnchorTag",id:"isanchortag",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"isBlock",id:"isblock",level:3},{value:"Usage",id:"usage-1",level:2},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isBlockByName",id:"isblockbyname",level:3},{value:"Usage",id:"usage-2",level:2},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isImageTag",id:"isimagetag",level:3},{value:"Usage",id:"usage-3",level:2},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isTwitterEmbed",id:"istwitterembed",level:3},{value:"Usage",id:"usage-4",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"isYoutubeEmbed",id:"isyoutubeembed",level:3},{value:"Usage",id:"usage-5",level:2},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"wpKsesPost",id:"wpksespost",level:3},{value:"Usage",id:"usage-6",level:2},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Data Fetching",id:"data-fetching",level:2},{value:"apiGet",id:"apiget",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"apiPost",id:"apipost",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"Data Handling",id:"data-handling",level:2},{value:"getPostAuthor",id:"getpostauthor",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getPostTerms",id:"getpostterms",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Other",id:"other",level:2},{value:"CustomPostType",id:"customposttype",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"CustomPostTypes",id:"customposttypes",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"CustomTaxonomies",id:"customtaxonomies",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"CustomTaxonomy",id:"customtaxonomy",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"DOMNode",id:"domnode",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"HTMLParser2Options",id:"htmlparser2options",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"HeadlessConfig",id:"headlessconfig",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"Integrations",id:"integrations",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"Matcher",id:"matcher",level:3},{value:"Type declaration",id:"type-declaration-4",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"NormalizedDataForCache",id:"normalizeddataforcache",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Type declaration",id:"type-declaration-5",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"PostOrPostsFetchStrategyResult",id:"postorpostsfetchstrategyresult",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Type declaration",id:"type-declaration-6",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"QueriedObject",id:"queriedobject",level:3},{value:"Type declaration",id:"type-declaration-7",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"Redirect",id:"redirect",level:3},{value:"Type declaration",id:"type-declaration-8",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"RedirectData",id:"redirectdata",level:3},{value:"Type declaration",id:"type-declaration-9",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"RedirectStrategy",id:"redirectstrategy",level:3},{value:"Defined in",id:"defined-in-25",level:4},{value:"isAnchorTagOptions",id:"isanchortagoptions",level:3},{value:"Type declaration",id:"type-declaration-10",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"isBlockOptions",id:"isblockoptions",level:3},{value:"Type declaration",id:"type-declaration-11",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"isImageTagOptions",id:"isimagetagoptions",level:3},{value:"Type declaration",id:"type-declaration-12",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"removeSourceUrlType",id:"removesourceurltype",level:3},{value:"Type declaration",id:"type-declaration-13",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"authorArchivesMatchers",id:"authorarchivesmatchers",level:3},{value:"Defined in",id:"defined-in-30",level:4},{value:"endpoints",id:"endpoints",level:3},{value:"Type declaration",id:"type-declaration-14",level:4},{value:"Defined in",id:"defined-in-31",level:4},{value:"ksesAllowedList",id:"ksesallowedlist",level:3},{value:"Defined in",id:"defined-in-32",level:4},{value:"postMatchers",id:"postmatchers",level:3},{value:"Defined in",id:"defined-in-33",level:4},{value:"postsMatchers",id:"postsmatchers",level:3},{value:"Defined in",id:"defined-in-34",level:4},{value:"searchMatchers",id:"searchmatchers",level:3},{value:"Defined in",id:"defined-in-35",level:4},{value:"youtubeEmbedRegex",id:"youtubeembedregex",level:3},{value:"Defined in",id:"defined-in-36",level:4},{value:"HTMLReactParser",id:"htmlreactparser",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-37",level:4},{value:"addQueryArgs",id:"addqueryargs",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-38",level:4},{value:"asyncForEach",id:"asyncforeach",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-39",level:4},{value:"attributesToProps",id:"attributestoprops",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"buildQueryString",id:"buildquerystring",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"decodeHtmlSpeciaChars",id:"decodehtmlspeciachars",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-42",level:4},{value:"domToReact",id:"domtoreact",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-43",level:4},{value:"fetchRedirect",id:"fetchredirect",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Defined in",id:"defined-in-44",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Returns",id:"returns-19",level:4},{value:"Defined in",id:"defined-in-45",level:4},{value:"getCustomPostType",id:"getcustomposttype",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"getCustomPostTypes",id:"getcustomposttypes",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"getCustomPostTypesSlugs",id:"getcustomposttypesslugs",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-22",level:4},{value:"Defined in",id:"defined-in-48",level:4},{value:"getCustomTaxonomies",id:"getcustomtaxonomies",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Defined in",id:"defined-in-49",level:4},{value:"getCustomTaxonomy",id:"getcustomtaxonomy",level:3},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-24",level:4},{value:"Defined in",id:"defined-in-50",level:4},{value:"getCustomTaxonomySlugs",id:"getcustomtaxonomyslugs",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Defined in",id:"defined-in-51",level:4},{value:"getHeadlessConfig",id:"getheadlessconfig",level:3},{value:"Returns",id:"returns-26",level:4},{value:"Defined in",id:"defined-in-52",level:4},{value:"getHeadstartWPConfig",id:"getheadstartwpconfig",level:3},{value:"Returns",id:"returns-27",level:4},{value:"Defined in",id:"defined-in-53",level:4},{value:"getHostUrl",id:"gethosturl",level:3},{value:"Returns",id:"returns-28",level:4},{value:"Defined in",id:"defined-in-54",level:4},{value:"getQueryArgs",id:"getqueryargs",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Defined in",id:"defined-in-55",level:4},{value:"getQueryString",id:"getquerystring",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Defined in",id:"defined-in-56",level:4},{value:"getSite",id:"getsite",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Defined in",id:"defined-in-57",level:4},{value:"getSiteByHost",id:"getsitebyhost",level:3},{value:"Parameters",id:"parameters-28",level:4},{value:"Returns",id:"returns-32",level:4},{value:"Defined in",id:"defined-in-58",level:4},{value:"getSiteBySourceUrl",id:"getsitebysourceurl",level:3},{value:"Parameters",id:"parameters-29",level:4},{value:"Returns",id:"returns-33",level:4},{value:"Defined in",id:"defined-in-59",level:4},{value:"getWPUrl",id:"getwpurl",level:3},{value:"Returns",id:"returns-34",level:4},{value:"Defined in",id:"defined-in-60",level:4},{value:"htmlToDOM",id:"htmltodom",level:3},{value:"Parameters",id:"parameters-30",level:4},{value:"Returns",id:"returns-35",level:4},{value:"Defined in",id:"defined-in-61",level:4},{value:"isElement",id:"iselement",level:3},{value:"Parameters",id:"parameters-31",level:4},{value:"Returns",id:"returns-36",level:4},{value:"Defined in",id:"defined-in-62",level:4},{value:"isExternalUrl",id:"isexternalurl",level:3},{value:"Parameters",id:"parameters-32",level:4},{value:"Returns",id:"returns-37",level:4},{value:"Defined in",id:"defined-in-63",level:4},{value:"isInternalLink",id:"isinternallink",level:3},{value:"Parameters",id:"parameters-33",level:4},{value:"Returns",id:"returns-38",level:4},{value:"Defined in",id:"defined-in-64",level:4},{value:"log",id:"log",level:3},{value:"Parameters",id:"parameters-34",level:4},{value:"Returns",id:"returns-39",level:4},{value:"Defined in",id:"defined-in-65",level:4},{value:"removeFieldsFromPostRelatedData",id:"removefieldsfrompostrelateddata",level:3},{value:"Parameters",id:"parameters-35",level:4},{value:"Returns",id:"returns-40",level:4},{value:"Defined in",id:"defined-in-66",level:4},{value:"removeSourceUrl",id:"removesourceurl",level:3},{value:"Parameters",id:"parameters-36",level:4},{value:"Returns",id:"returns-41",level:4},{value:"Defined in",id:"defined-in-67",level:4},{value:"setHeadlessConfig",id:"setheadlessconfig",level:3},{value:"Parameters",id:"parameters-37",level:4},{value:"Returns",id:"returns-42",level:4},{value:"Defined in",id:"defined-in-68",level:4},{value:"setHeadstartWPConfig",id:"setheadstartwpconfig",level:3},{value:"Parameters",id:"parameters-38",level:4},{value:"Returns",id:"returns-43",level:4},{value:"Defined in",id:"defined-in-69",level:4},{value:"stripTags",id:"striptags",level:3},{value:"Parameters",id:"parameters-39",level:4},{value:"Returns",id:"returns-44",level:4},{value:"Defined in",id:"defined-in-70",level:4},{value:"warn",id:"warn",level:3},{value:"Parameters",id:"parameters-40",level:4},{value:"Returns",id:"returns-45",level:4},{value:"Defined in",id:"defined-in-71",level:4},{value:"Utility Functions",id:"utility-functions",level:2},{value:"parsePath",id:"parsepath",level:3},{value:"Parameters",id:"parameters-41",level:4},{value:"Returns",id:"returns-46",level:4},{value:"Defined in",id:"defined-in-72",level:4}],s={toc:o};function m(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"namespaces"},"Namespaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/namespaces/headstartwp_core.react"},"react"))),(0,r.kt)("h2",{id:"enumerations"},"Enumerations"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/enums/headstartwp_core.LOGTYPE"},"LOGTYPE"))),(0,r.kt)("h2",{id:"classes"},"Classes"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.AppSettingsStrategy"},"AppSettingsStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy"},"AuthorArchiveFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.Comment"},"Comment")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.ConfigError"},"ConfigError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.Element"},"Element")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.EndpointError"},"EndpointError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.FetchError"},"FetchError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.FrameworkError"},"FrameworkError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.NotFoundError"},"NotFoundError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy"},"PostOrPostsFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.ProcessingInstruction"},"ProcessingInstruction")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.SearchFetchStrategy"},"SearchFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"},"SinglePostFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy"},"TaxonomyTermsStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.Text"},"Text")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy"},"VerifyTokenFetchStrategy"))),(0,r.kt)("h2",{id:"interfaces"},"Interfaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},"AppEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.AttachmentEntity"},"AttachmentEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},"AuthorEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.AvatarUrls"},"AvatarUrls")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.CommentEntity"},"CommentEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},"FetchOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},"FetchResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},"FilterDataOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"},"HTMLReactParserOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.Integration"},"Integration")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},"MenuItemEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PageEntity"},"PageEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},"PageInfo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PolylangIntegration"},"PolylangIntegration")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},"PostEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},"PostOrPostsParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostParams"},"PostParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},"PostsArchiveParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.Rendered"},"Rendered")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.RevisionEntity"},"RevisionEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.SearchEntity"},"SearchEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},"TaxonomyArchiveParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.TaxonomyEntity"},"TaxonomyEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},"TermEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.TypeEntity"},"TypeEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"},"VerifyTokenParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration"},"YoastSEOIntegration"))),(0,r.kt)("h2",{id:"dom-helpers"},"DOM Helpers"),(0,r.kt)("h3",{id:"isanchortag"},"isAnchorTag"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isAnchorTag"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): node is Element"),(0,r.kt)("p",null,"Checks if the provided node is an valid anchor tag"),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h2",{id:"usage"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isAnchorTag } from '@headstartwp/core';\nimport { LinkBlock } from '@10up/headless-next';\n\n\n isAnchorTag(node, { isInternalLink: true})} />\n\n")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#isanchortagoptions"},(0,r.kt)("inlineCode",{parentName:"a"},"isAnchorTagOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Supported options")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,"node is Element"),(0,r.kt)("p",null,"Whether it's an anchor tag according to the options passed"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/dom/index.ts#L77"},"packages/core/src/dom/index.ts:77")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isblock"},"isBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"_options"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Tests a node by tagName and/or className"),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h2",{id:"usage-1"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isBlock } from '@headstartwp/core';\n\n\n isBlock(node, { tagName: 'div', classList: ['block-class-name'] })}\n />\n\n")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"_options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#isblockoptions"},(0,r.kt)("inlineCode",{parentName:"a"},"isBlockOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"true if the node passes the test"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/dom/index.ts#L278"},"packages/core/src/dom/index.ts:278")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isblockbyname"},"isBlockByName"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isBlockByName"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"name"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Tests a node by block name. This requires the Headless WP Plugin to be installed."),(0,r.kt)("p",null,"The Headless WP Plugin will append ",(0,r.kt)("inlineCode",{parentName:"p"},"data-wp-block-name")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"data-wp-block")," to every block,\nthis function relies on those attributes to determine if the node is a block."),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h2",{id:"usage-2"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isBlockByName } from '@headstartwp/core';\n\n\n isBlock(node, 'core/paragraph')}\n />\n\n")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The block name")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"true if the node passes the test"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/dom/index.ts#L334"},"packages/core/src/dom/index.ts:334")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isimagetag"},"isImageTag"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isImageTag"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Checks if the provided node is an valid image tag"),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h2",{id:"usage-3"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isImageTag, ImageBlock } from '@headstartwp/core';\nimport { ImageComponent } from '@10up/headless-next';\n\n\n isImageTag(node, { hasDimensions: true})}\n component={ImageComponent}\n />\n\n")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#isimagetagoptions"},(0,r.kt)("inlineCode",{parentName:"a"},"isImageTagOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Supported options.")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Whether it's an image tag or not according to the options passed"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/dom/index.ts#L141"},"packages/core/src/dom/index.ts:141")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"istwitterembed"},"isTwitterEmbed"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isTwitterEmbed"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Checks if the node is an twitter embed"),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h2",{id:"usage-4"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isTwitterEmbed } from '@headstartwp/core';\n\n\n \n\n")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"true if the node is a twitter embed"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/dom/index.ts#L227"},"packages/core/src/dom/index.ts:227")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isyoutubeembed"},"isYoutubeEmbed"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isYoutubeEmbed"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Checks if the node is an youtube embed"),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h2",{id:"usage-5"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isYoutubeEmbed } from '@headstartwp/core';\n\n\n \n\n")),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"true if the node is a youtube embed"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/dom/index.ts#L187"},"packages/core/src/dom/index.ts:187")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"wpksespost"},"wpKsesPost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"wpKsesPost"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"content"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"allowList?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Sanitize HTML content by the wp_kses_post() requirements"),(0,r.kt)("h2",{id:"usage-6"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { wpKsesPost } from '@headstartwp/core';\nwpKsesPost(html);\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://codex.wordpress.org/Function_Reference/wp_kses_post"},"https://codex.wordpress.org/Function_Reference/wp_kses_post")),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"content")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The content to sanitize.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"allowList?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"IWhiteList")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Optional. The list of allowed HTML tags and attributes. If not set, the default allow list will be used.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"IWpKsesPostOptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Optional. IWpKsesPostOptions.")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Sanitized string of HTML."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/dom/wpKsesPost.ts#L30"},"packages/core/src/dom/wpKsesPost.ts:30")),(0,r.kt)("h2",{id:"data-fetching"},"Data Fetching"),(0,r.kt)("h3",{id:"apiget"},"apiGet"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"apiGet"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"args?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"burstCache?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"headers"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"[index: string]"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"; } = receivedHeaders; ",(0,r.kt)("inlineCode",{parentName:"p"},"json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," }",">"),(0,r.kt)("p",null,"Fetch Wrapper to handle GET requests."),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The URL where to make the request to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The arguments")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"burstCache")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether it should burst cache")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"headers"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"[index: string]"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"; } = receivedHeaders; ",(0,r.kt)("inlineCode",{parentName:"p"},"json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," }",">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/api/fetch-utils.ts#L46"},"packages/core/src/data/api/fetch-utils.ts:46")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"apipost"},"apiPost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"apiPost"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"args?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Fetch Wrapper to handle POST requests"),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The URL where to make the request to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The arguments")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/api/fetch-utils.ts#L17"},"packages/core/src/data/api/fetch-utils.ts:17")),(0,r.kt)("h2",{id:"data-handling"},"Data Handling"),(0,r.kt)("h3",{id:"getpostauthor"},"getPostAuthor"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getPostAuthor"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"post"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,r.kt)("p",null,"Returns the author object from the post object if it exists"),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"post")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Post object")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/utils/postHandling.ts#L11"},"packages/core/src/data/utils/postHandling.ts:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getpostterms"},"getPostTerms"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getPostTerms"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"post"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,r.kt)("p",null,"Returns the terms associated with the post"),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"post")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Post object")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/utils/postHandling.ts#L22"},"packages/core/src/data/utils/postHandling.ts:22")),(0,r.kt)("h2",{id:"other"},"Other"),(0,r.kt)("h3",{id:"customposttype"},"CustomPostType"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"CustomPostType"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"archive?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"matchSinglePath?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether this custom post type should match the archive path If set to true, then when querying a post type archive page such as ",(0,r.kt)("inlineCode",{parentName:"td"},"/[post-type]/[post-name]")," the ",(0,r.kt)("inlineCode",{parentName:"td"},"post.link")," property should match the current path. This will avoid matching nested posts/pages that doesn't exist for instance: ",(0,r.kt)("inlineCode",{parentName:"td"},"/[post-type]/fake-parent-page/[post-name]")," will not match if this option is set to true even though ",(0,r.kt)("inlineCode",{parentName:"td"},"post-name")," exists. It is strongly recommended to set this option to true, otherwise hierarchical post types (such as pages) will not work properly. ",(0,r.kt)("strong",{parentName:"td"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))," true")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"single?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/types.ts#L1"},"packages/core/src/types.ts:1")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"customposttypes"},"CustomPostTypes"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"CustomPostTypes"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customposttype"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostType")),"[]"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/types.ts#L21"},"packages/core/src/types.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"customtaxonomies"},"CustomTaxonomies"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"CustomTaxonomies"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customtaxonomy"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomy")),"[]"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/types.ts#L43"},"packages/core/src/types.ts:43")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"customtaxonomy"},"CustomTaxonomy"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"CustomTaxonomy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"matchArchivePath?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether this custom taxonomy should match the archive path If set to true, then when querying a taxonomy archive page such as ",(0,r.kt)("inlineCode",{parentName:"td"},"/[taxonmy-slug]/[term-slug]")," the ",(0,r.kt)("inlineCode",{parentName:"td"},"term.link")," property should match the current path. This will avoid matching nested categories that doesn't exist for instance: ",(0,r.kt)("inlineCode",{parentName:"td"},"/[taxonmy-slug]/fake-parent-term/[term-slug]")," will not match if this option is set to true even though ",(0,r.kt)("inlineCode",{parentName:"td"},"term-slug")," exists. ",(0,r.kt)("strong",{parentName:"td"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))," false")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"restParam?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"rewrite?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/types.ts#L25"},"packages/core/src/types.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"DOMNode"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"DOMNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Comment"},(0,r.kt)("inlineCode",{parentName:"a"},"Comment"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Node")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.ProcessingInstruction"},(0,r.kt)("inlineCode",{parentName:"a"},"ProcessingInstruction"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Text"},(0,r.kt)("inlineCode",{parentName:"a"},"Text"))),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-react-parser/index.d.ts:21"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"htmlparser2options"},"HTMLParser2Options"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HTMLParser2Options"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ParserOptions")," & ",(0,r.kt)("inlineCode",{parentName:"p"},"DomHandlerOptions")),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-react-parser/index.d.ts:19"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headlessconfig"},"HeadlessConfig"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessConfig"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customPostTypes?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes"))," ","|"," (",(0,r.kt)("inlineCode",{parentName:"td"},"defaultPostTypes"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes")),") => ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customTaxonomies?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies"))," ","|"," (",(0,r.kt)("inlineCode",{parentName:"td"},"defaultTaxonomies"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies")),") => ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"devMode?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"redirects?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"requests?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug.devMode?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug.redirects?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug.requests?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"host?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hostUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"integrations?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#integrations"},(0,r.kt)("inlineCode",{parentName:"a"},"Integrations")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"locale?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirectStrategy?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#redirectstrategy"},(0,r.kt)("inlineCode",{parentName:"a"},"RedirectStrategy")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sites?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"useWordPressPlugin?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/types.ts#L58"},"packages/core/src/types.ts:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"integrations"},"Integrations"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Integrations"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"polylang?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PolylangIntegration"},(0,r.kt)("inlineCode",{parentName:"a"},"PolylangIntegration")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"yoastSEO?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration"},(0,r.kt)("inlineCode",{parentName:"a"},"YoastSEOIntegration")))))),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/types.ts#L53"},"packages/core/src/types.ts:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"matcher"},"Matcher"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Matcher"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-4"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pattern")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"priority")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/utils/matchers.ts#L1"},"packages/core/src/data/utils/matchers.ts:1")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"normalizeddataforcache"},"NormalizedDataForCache"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"NormalizedDataForCache"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P"))))),(0,r.kt)("h4",{id:"type-declaration-5"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"additionalCacheObjects?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,r.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">","[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"url"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key.args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key.url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L83"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:83")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"postorpostsfetchstrategyresult"},"PostOrPostsFetchStrategyResult"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"PostOrPostsFetchStrategyResult"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))))),(0,r.kt)("h4",{id:"type-declaration-6"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isSingle")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L42"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:42")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"queriedobject"},"QueriedObject"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"QueriedObject"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The QueriedObject represents the object that the current requests is subjected to."),(0,r.kt)("p",null,"Querying by taxonomy and/or author will set the queried object."),(0,r.kt)("h4",{id:"type-declaration-7"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"author?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the request is an author query, this will be populated with the author object")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"search?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.SearchEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"SearchEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the request is a search query, this will be populated with the search entity object")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"term?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the request is a term query, this will be populated with the term object")))),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L707"},"packages/core/src/data/types/entities.ts:707")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"redirect"},"Redirect"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Redirect"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-8"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ID")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"enable_regex")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"post_status")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirect_from")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirect_to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"status_code")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L647"},"packages/core/src/data/types/entities.ts:647")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"redirectdata"},"RedirectData"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"RedirectData"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-9"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"location")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"null")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The redirect new location will be null if no redirect is found")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"status")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The status number of the redirect Will be 0 if the redirect is not found")))),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/fetchRedirect.ts#L5"},"packages/core/src/utils/fetchRedirect.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"redirectstrategy"},"RedirectStrategy"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"RedirectStrategy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"404"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"none"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"always"')),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/types.ts#L23"},"packages/core/src/types.ts:23")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isanchortagoptions"},"isAnchorTagOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"isAnchorTagOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-10"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isInternalLink?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},'If true, will check if the anchor tag contains a valid internal link. if target="_blank" then this option is not taken into account')))),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/dom/index.ts#L5"},"packages/core/src/dom/index.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isblockoptions"},"isBlockOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"isBlockOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-11"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"className?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"A single or array of classNames to check for If an array of class names is passed, the block will be considered valid if all of the class names are found")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tagName?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The tagName to check for")))),(0,r.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/dom/index.ts#L238"},"packages/core/src/dom/index.ts:238")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isimagetagoptions"},"isImageTagOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"isImageTagOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-12"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hasDimensions?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If true, will check if the image tag contains width and height attributes")))),(0,r.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/dom/index.ts#L107"},"packages/core/src/dom/index.ts:107")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removesourceurltype"},"removeSourceUrlType"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"removeSourceUrlType"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-13"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"backendUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The backend url.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"link")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The link url, possibly with the source url.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"publicUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The public url. Defaults to '/'.")))),(0,r.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/removeSourceUrl.ts#L3"},"packages/core/src/utils/removeSourceUrl.ts:3")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"authorarchivesmatchers"},"authorArchivesMatchers"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"authorArchivesMatchers"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#matcher"},(0,r.kt)("inlineCode",{parentName:"a"},"Matcher")),"[]"),(0,r.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/utils/matchers.ts#L43"},"packages/core/src/data/utils/matchers.ts:43")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"endpoints"},"endpoints"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"endpoints"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-14"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"appSettings")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"category")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pages")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"posts")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tags")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tokenVerify")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"yoast")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/endpoints.ts#L1"},"packages/core/src/utils/endpoints.ts:1")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ksesallowedlist"},"ksesAllowedList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"ksesAllowedList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"IWhiteList")),(0,r.kt)("p",null,"Default Allowed HTML Attributes"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://codex.wordpress.org/Function_Reference/wp_kses_post"},"https://codex.wordpress.org/Function_Reference/wp_kses_post")),(0,r.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/dom/wpKsesPost.ts#L266"},"packages/core/src/dom/wpKsesPost.ts:266")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"postmatchers"},"postMatchers"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"postMatchers"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#matcher"},(0,r.kt)("inlineCode",{parentName:"a"},"Matcher")),"[]"),(0,r.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/utils/matchers.ts#L7"},"packages/core/src/data/utils/matchers.ts:7")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"postsmatchers"},"postsMatchers"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"postsMatchers"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#matcher"},(0,r.kt)("inlineCode",{parentName:"a"},"Matcher")),"[]"),(0,r.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/utils/matchers.ts#L20"},"packages/core/src/data/utils/matchers.ts:20")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"searchmatchers"},"searchMatchers"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"searchMatchers"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#matcher"},(0,r.kt)("inlineCode",{parentName:"a"},"Matcher")),"[]"),(0,r.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/utils/matchers.ts#L56"},"packages/core/src/data/utils/matchers.ts:56")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"youtubeembedregex"},"youtubeEmbedRegex"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"youtubeEmbedRegex"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"RegExp")),(0,r.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/dom/index.ts#L160"},"packages/core/src/dom/index.ts:160")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"htmlreactparser"},"HTMLReactParser"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"HTMLReactParser"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"html"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"ReturnType"),""),(0,r.kt)("p",null,"Converts HTML string to JSX element(s)."),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"html")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"HTML string.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"HTMLReactParserOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Parser options.")))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"ReturnType"),""),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"JSX element(s), empty array, or string.")),(0,r.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-react-parser/index.d.ts:51"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"addqueryargs"},"addQueryArgs"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addQueryArgs"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"args"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/url.ts#L167"},"packages/core/src/utils/url.ts:167")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"asyncforeach"},"asyncForEach"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"asyncForEach"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"array"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"callback"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"array")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"callback")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"el"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"index"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"array"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]) => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/asyncForEach.ts#L1"},"packages/core/src/utils/asyncForEach.ts:1")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"attributestoprops"},"attributesToProps"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"attributesToProps"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"attributes"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"nodeName?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Props")),(0,r.kt)("p",null,"Converts HTML/SVG DOM attributes to React props."),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"attributes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Attributes")),(0,r.kt)("td",{parentName:"tr",align:"left"},"HTML/SVG DOM attributes.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nodeName?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"DOM node name.")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Props")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"React props.")),(0,r.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-react-parser/lib/attributes-to-props.d.ts:17"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"buildquerystring"},"buildQueryString"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"buildQueryString"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Generates URL-encoded query string using input query data."),(0,r.kt)("p",null,"It is intended to behave equivalent as PHP's ",(0,r.kt)("inlineCode",{parentName:"p"},"http_build_query"),", configured\nwith encoding type PHP_QUERY_RFC3986 (spaces as ",(0,r.kt)("inlineCode",{parentName:"p"},"%20"),")."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const queryString = buildQueryString( {\n simple: 'is ok',\n arrays: [ 'are', 'fine', 'too' ],\n objects: {\n evenNested: {\n ok: 'yes',\n },\n },\n} );\n// \"simple=is%20ok&arrays%5B0%5D=are&arrays%5B1%5D=fine&arrays%5B2%5D=too&objects%5BevenNested%5D%5Bok%5D=yes\"\n")),(0,r.kt)("h4",{id:"parameters-15"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Data to encode.")))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Query string."),(0,r.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/url.ts#L129"},"packages/core/src/utils/url.ts:129")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"decodehtmlspeciachars"},"decodeHtmlSpeciaChars"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"decodeHtmlSpeciaChars"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"text"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Decodes HTML special chars entities"),(0,r.kt)("h4",{id:"parameters-16"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The text we want to decode")))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"text with decoded html entities"),(0,r.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/decodeHtmlSpeciaChars.ts#L8"},"packages/core/src/utils/decodeHtmlSpeciaChars.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domtoreact"},"domToReact"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"domToReact"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"nodes"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element"),"[]"),(0,r.kt)("p",null,"Converts DOM nodes to JSX element(s)."),(0,r.kt)("h4",{id:"parameters-17"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nodes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"DOM nodes.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"HTMLReactParserOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Parser options.")))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element"),"[]"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"JSX element(s).")),(0,r.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-react-parser/lib/dom-to-react.d.ts:15"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchredirect"},"fetchRedirect"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchRedirect"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"pathname"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#redirectdata"},(0,r.kt)("inlineCode",{parentName:"a"},"RedirectData")),">"),(0,r.kt)("p",null,"Fetches a redirect from the WordPress origin by making a HEAD request and checking the response"),(0,r.kt)("h4",{id:"parameters-18"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pathname")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path to the page to fetch the redirect for")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The source url")))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#redirectdata"},(0,r.kt)("inlineCode",{parentName:"a"},"RedirectData")),">"),(0,r.kt)("p",null,"The redirect data"),(0,r.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/fetchRedirect.ts#L51"},"packages/core/src/utils/fetchRedirect.ts:51")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAuthHeader"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/api/fetch-utils.ts#L3"},"packages/core/src/data/api/fetch-utils.ts:3")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomposttype"},"getCustomPostType"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomPostType"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"slug"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customposttype"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostType"))),(0,r.kt)("p",null,"Returns a single post type by slug if defined"),(0,r.kt)("h4",{id:"parameters-19"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"post type slug")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns-20"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customposttype"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostType"))),(0,r.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/config.ts#L248"},"packages/core/src/utils/config.ts:248")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomposttypes"},"getCustomPostTypes"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomPostTypes"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes"))),(0,r.kt)("p",null,"Returns the available post types"),(0,r.kt)("h4",{id:"parameters-20"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-21"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes"))),(0,r.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/config.ts#L225"},"packages/core/src/utils/config.ts:225")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomposttypesslugs"},"getCustomPostTypesSlugs"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomPostTypesSlugs"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Returns the available post type slugs"),(0,r.kt)("h4",{id:"parameters-21"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-22"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/config.ts#L236"},"packages/core/src/utils/config.ts:236")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomtaxonomies"},"getCustomTaxonomies"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomTaxonomies"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies"))),(0,r.kt)("p",null,"Returns the available taxonomies"),(0,r.kt)("h4",{id:"parameters-22"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-23"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies"))),(0,r.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/config.ts#L185"},"packages/core/src/utils/config.ts:185")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomtaxonomy"},"getCustomTaxonomy"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomTaxonomy"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"slug"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customtaxonomy"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomy"))),(0,r.kt)("p",null,"Returns a single post type by slug if defined"),(0,r.kt)("h4",{id:"parameters-23"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"post type slug")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns-24"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customtaxonomy"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomy"))),(0,r.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/config.ts#L214"},"packages/core/src/utils/config.ts:214")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomtaxonomyslugs"},"getCustomTaxonomySlugs"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomTaxonomySlugs"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Returns the available taxonomy slugs"),(0,r.kt)("h4",{id:"parameters-24"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-25"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/config.ts#L197"},"packages/core/src/utils/config.ts:197")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getheadlessconfig"},"getHeadlessConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getHeadlessConfig"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Returns the contents of headless.config.js"),(0,r.kt)("p",null,"This function requires framework integration in order to work. The contents of ",(0,r.kt)("inlineCode",{parentName:"p"},"headless.config.js"),"\nneeds to be injected at build time into a global variable."),(0,r.kt)("p",null,"Make sure you are using one of the framework's integration (such as next) before using this function."),(0,r.kt)("h4",{id:"returns-26"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The contents of headless.config.js"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customPostTypes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customTaxonomies")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"td"},"devMode?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"redirects?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"requests?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hostUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"integrations")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#integrations"},(0,r.kt)("inlineCode",{parentName:"a"},"Integrations")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirectStrategy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#redirectstrategy"},(0,r.kt)("inlineCode",{parentName:"a"},"RedirectStrategy")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sites")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"useWordPressPlugin")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/config.ts#L22"},"packages/core/src/utils/config.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getheadstartwpconfig"},"getHeadstartWPConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getHeadstartWPConfig"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Returns the contents of headless.config.js"),(0,r.kt)("p",null,"This function requires framework integration in order to work. The contents of ",(0,r.kt)("inlineCode",{parentName:"p"},"headless.config.js"),"\nneeds to be injected at build time into a global variable."),(0,r.kt)("p",null,"Make sure you are using one of the framework's integration (such as next) before using this function."),(0,r.kt)("h4",{id:"returns-27"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The contents of headless.config.js"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customPostTypes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customTaxonomies")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"td"},"devMode?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"redirects?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"requests?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hostUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"integrations")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#integrations"},(0,r.kt)("inlineCode",{parentName:"a"},"Integrations")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirectStrategy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#redirectstrategy"},(0,r.kt)("inlineCode",{parentName:"a"},"RedirectStrategy")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sites")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"useWordPressPlugin")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-53"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/config.ts#L22"},"packages/core/src/utils/config.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"gethosturl"},"getHostUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getHostUrl"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the WP URL based on the headless config"),(0,r.kt)("h4",{id:"returns-28"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-54"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/config.ts#L265"},"packages/core/src/utils/config.ts:265")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getqueryargs"},"getQueryArgs"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getQueryArgs"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Returns an object of query arguments of the given URL. If the given URL is\ninvalid or has no querystring, an empty object is returned."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},'const foo = getQueryArgs( \'https://wordpress.org?foo=bar&bar=baz\' );\n// { "foo": "bar", "bar": "baz" }\n')),(0,r.kt)("h4",{id:"parameters-25"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"URL.")))),(0,r.kt)("h4",{id:"returns-29"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Query args object."),(0,r.kt)("h4",{id:"defined-in-55"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/url.ts#L78"},"packages/core/src/utils/url.ts:78")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getquerystring"},"getQueryString"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getQueryString"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"parameters-26"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-30"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"defined-in-56"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/url.ts#L49"},"packages/core/src/utils/url.ts:49")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsite"},"getSite"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSite"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("p",null,"Get a config for a specific site"),(0,r.kt)("h4",{id:"parameters-27"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h4",{id:"returns-31"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("h4",{id:"defined-in-57"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/config.ts#L111"},"packages/core/src/utils/config.ts:111")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsitebyhost"},"getSiteByHost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSiteByHost"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"hostOrUrl"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"locale?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("p",null,"Finds a site by host and optionally locale"),(0,r.kt)("h4",{id:"parameters-28"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hostOrUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The hostname")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"locale?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns-32"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("h4",{id:"defined-in-58"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/config.ts#L135"},"packages/core/src/utils/config.ts:135")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsitebysourceurl"},"getSiteBySourceUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSiteBySourceUrl"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("p",null,"Get a site by source url"),(0,r.kt)("h4",{id:"parameters-29"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-33"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("p",null,"HeadlessConfig"),(0,r.kt)("h4",{id:"defined-in-59"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/config.ts#L173"},"packages/core/src/utils/config.ts:173")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getwpurl"},"getWPUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getWPUrl"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the WP URL based on the headless config"),(0,r.kt)("h4",{id:"returns-34"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-60"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/config.ts#L257"},"packages/core/src/utils/config.ts:257")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"htmltodom"},"htmlToDOM"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"htmlToDOM"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"html"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): (",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Comment"},(0,r.kt)("inlineCode",{parentName:"a"},"Comment"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.ProcessingInstruction"},(0,r.kt)("inlineCode",{parentName:"a"},"ProcessingInstruction"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Text"},(0,r.kt)("inlineCode",{parentName:"a"},"Text")),")[]"),(0,r.kt)("p",null,"Parses HTML string to DOM nodes in Node.js."),(0,r.kt)("p",null,"This is the same method as ",(0,r.kt)("inlineCode",{parentName:"p"},"require('htmlparser2').parseDOM"),"\n",(0,r.kt)("a",{parentName:"p",href:"https://github.com/fb55/htmlparser2/blob/v6.0.0/src/index.ts#L29-L41"},"https://github.com/fb55/htmlparser2/blob/v6.0.0/src/index.ts#L29-L41")),(0,r.kt)("h4",{id:"parameters-30"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"html")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"HTML markup.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"DomHandlerOptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Parser options (",(0,r.kt)("a",{parentName:"td",href:"https://github.com/fb55/domhandler/tree/v5.0.3#readme"},"https://github.com/fb55/domhandler/tree/v5.0.3#readme"),").")))),(0,r.kt)("h4",{id:"returns-35"},"Returns"),(0,r.kt)("p",null,"(",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Comment"},(0,r.kt)("inlineCode",{parentName:"a"},"Comment"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.ProcessingInstruction"},(0,r.kt)("inlineCode",{parentName:"a"},"ProcessingInstruction"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Text"},(0,r.kt)("inlineCode",{parentName:"a"},"Text")),")[]"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"DOM nodes.")),(0,r.kt)("h4",{id:"defined-in-61"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-dom-parser/lib/server/html-to-dom.d.ts:21"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"iselement"},"isElement"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isElement"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): node is Element"),(0,r.kt)("p",null,"Checks if the node is an Element."),(0,r.kt)("p",null,"We rely on this function to avoid issues with instanceof."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/issues/504"},"https://github.com/10up/headstartwp/issues/504")),(0,r.kt)("h4",{id:"parameters-31"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The dom node")))),(0,r.kt)("h4",{id:"returns-36"},"Returns"),(0,r.kt)("p",null,"node is Element"),(0,r.kt)("p",null,"Whether the node is of type element or not"),(0,r.kt)("h4",{id:"defined-in-62"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/dom/index.ts#L25"},"packages/core/src/dom/index.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isexternalurl"},"isExternalUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isExternalUrl"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"link"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Checks if the provided link is an external Url."),(0,r.kt)("p",null,"Inspired on the Frontity implementation"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts"},"https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts")),(0,r.kt)("h4",{id:"parameters-32"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"link")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The link Url.")))),(0,r.kt)("h4",{id:"returns-37"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"True if the link is an external Url."),(0,r.kt)("h4",{id:"defined-in-63"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/isExternalUrl.ts#L12"},"packages/core/src/utils/isExternalUrl.ts:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isinternallink"},"isInternalLink"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isInternalLink"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Checks if the url is for an internal link"),(0,r.kt)("h4",{id:"parameters-33"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The url to check")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"(optional) the site config")))),(0,r.kt)("h4",{id:"returns-38"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-64"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/isInternalLink.ts#L14"},"packages/core/src/utils/isInternalLink.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"log"},"log"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"log"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"type"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"...args"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-34"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"type")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/headstartwp_core.LOGTYPE"},(0,r.kt)("inlineCode",{parentName:"a"},"LOGTYPE")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"...args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]")))),(0,r.kt)("h4",{id:"returns-39"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-65"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/log.ts#L9"},"packages/core/src/utils/log.ts:9")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removefieldsfrompostrelateddata"},"removeFieldsFromPostRelatedData"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeFieldsFromPostRelatedData"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fieldsToRemove"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"post"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"_embedded"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"author"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wp:featuredmedia"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wp:term"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]"," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"categories?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"comment_status?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"closed"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"content"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"date"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"date_gmt"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"excerpt"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"featured_media"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"format"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"link"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"status"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"standard"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"aside"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"chat"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"gallery"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"image"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"quote"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"video"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"audio"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"guid"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"modified"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"modified_gmt"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"ping_status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"closed"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"private"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sticky"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"tags?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"template"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"terms?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"title"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head_json?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," }"),(0,r.kt)("h4",{id:"parameters-35"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fieldsToRemove")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"number"),")[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"post")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))))),(0,r.kt)("h4",{id:"returns-40"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"_embedded"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"author"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wp:featuredmedia"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wp:term"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]"," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"categories?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"comment_status?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"closed"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"content"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"date"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"date_gmt"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"excerpt"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"featured_media"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"format"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"link"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"status"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"standard"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"aside"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"chat"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"gallery"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"image"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"quote"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"video"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"audio"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"guid"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"modified"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"modified_gmt"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"ping_status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"closed"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"private"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sticky"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"tags?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"template"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"terms?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"title"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head_json?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," }"),(0,r.kt)("h4",{id:"defined-in-66"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/utils/postHandling.ts#L47"},"packages/core/src/data/utils/postHandling.ts:47")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removesourceurl"},"removeSourceUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeSourceUrl"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Make the link relative if it belongs to the backend, to force client-side\nnavigation."),(0,r.kt)("p",null,"Inspired on the Frontity implementation"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts"},"https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts")),(0,r.kt)("h4",{id:"parameters-36"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#removesourceurltype"},(0,r.kt)("inlineCode",{parentName:"a"},"removeSourceUrlType")))))),(0,r.kt)("h4",{id:"returns-41"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The URL without the Source URL."),(0,r.kt)("h4",{id:"defined-in-67"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/removeSourceUrl.ts#L30"},"packages/core/src/utils/removeSourceUrl.ts:30")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setheadlessconfig"},"setHeadlessConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setHeadlessConfig"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-37"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h4",{id:"returns-42"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-68"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/config.ts#L6"},"packages/core/src/utils/config.ts:6")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setheadstartwpconfig"},"setHeadstartWPConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setHeadstartWPConfig"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-38"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h4",{id:"returns-43"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-69"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/config.ts#L6"},"packages/core/src/utils/config.ts:6")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"striptags"},"stripTags"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"stripTags"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"html"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("p",null,"Utility functions to strip any tags"),(0,r.kt)("h4",{id:"parameters-39"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"html")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The html string")))),(0,r.kt)("h4",{id:"returns-44"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"defined-in-70"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/dom/stripTags.ts#L8"},"packages/core/src/dom/stripTags.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"warn"},"warn"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"warn"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"message"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Logs a warning in the console in dev mode"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},'warn("You should do/change something.")\n')),(0,r.kt)("h4",{id:"parameters-40"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The message that describes the warning.")))),(0,r.kt)("h4",{id:"returns-45"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-71"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/errors.ts#L45"},"packages/core/src/utils/errors.ts:45")),(0,r.kt)("h2",{id:"utility-functions"},"Utility Functions"),(0,r.kt)("h3",{id:"parsepath"},"parsePath"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"parsePath"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"matchers"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Parses a path and extracts the parameters from it"),(0,r.kt)("h4",{id:"parameters-41"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"matchers")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#matcher"},(0,r.kt)("inlineCode",{parentName:"a"},"Matcher")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"An array of Matchers")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path")))),(0,r.kt)("h4",{id:"returns-46"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"the extracted parameters"),(0,r.kt)("h4",{id:"defined-in-72"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/utils/parsePath.ts#L46"},"packages/core/src/data/utils/parsePath.ts:46")))}m.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2925],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>u});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var d=n.createContext({}),o=function(e){var t=n.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},s=function(e){var t=o(e.components);return n.createElement(d.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},N=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),m=o(a),N=r,u=m["".concat(d,".").concat(N)]||m[N]||k[N]||i;return a?n.createElement(u,l(l({ref:t},s),{},{components:a})):n.createElement(u,l({ref:t},s))}));function u(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,l=new Array(i);l[0]=N;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p[m]="string"==typeof e?e:r,l[1]=p;for(var o=2;o{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>m,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core",title:"Module: @headstartwp/core",sidebar_label:"@headstartwp/core",sidebar_position:0,custom_edit_url:null},l=void 0,p={unversionedId:"modules/headstartwp_core",id:"modules/headstartwp_core",title:"Module: @headstartwp/core",description:"Namespaces",source:"@site/docs/modules/headstartwp_core.md",sourceDirName:"modules",slug:"/modules/headstartwp_core",permalink:"/docs/api/modules/headstartwp_core",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"headstartwp_core",title:"Module: @headstartwp/core",sidebar_label:"@headstartwp/core",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Table of Contents",permalink:"/docs/api/"},next:{title:"@headstartwp/next",permalink:"/docs/api/modules/headstartwp_next"}},d={},o=[{value:"Namespaces",id:"namespaces",level:2},{value:"Enumerations",id:"enumerations",level:2},{value:"Classes",id:"classes",level:2},{value:"Interfaces",id:"interfaces",level:2},{value:"DOM Helpers",id:"dom-helpers",level:2},{value:"isAnchorTag",id:"isanchortag",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"isBlock",id:"isblock",level:3},{value:"Usage",id:"usage-1",level:2},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isBlockByName",id:"isblockbyname",level:3},{value:"Usage",id:"usage-2",level:2},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isImageTag",id:"isimagetag",level:3},{value:"Usage",id:"usage-3",level:2},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isTwitterEmbed",id:"istwitterembed",level:3},{value:"Usage",id:"usage-4",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"isYoutubeEmbed",id:"isyoutubeembed",level:3},{value:"Usage",id:"usage-5",level:2},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"wpKsesPost",id:"wpksespost",level:3},{value:"Usage",id:"usage-6",level:2},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Data Fetching",id:"data-fetching",level:2},{value:"apiGet",id:"apiget",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"apiPost",id:"apipost",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"Data Handling",id:"data-handling",level:2},{value:"getPostAuthor",id:"getpostauthor",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getPostTerms",id:"getpostterms",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Other",id:"other",level:2},{value:"CustomPostType",id:"customposttype",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"CustomPostTypes",id:"customposttypes",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"CustomTaxonomies",id:"customtaxonomies",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"CustomTaxonomy",id:"customtaxonomy",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"DOMNode",id:"domnode",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"HTMLParser2Options",id:"htmlparser2options",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"HeadlessConfig",id:"headlessconfig",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"Integrations",id:"integrations",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"Matcher",id:"matcher",level:3},{value:"Type declaration",id:"type-declaration-4",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"NormalizedDataForCache",id:"normalizeddataforcache",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Type declaration",id:"type-declaration-5",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"PostOrPostsFetchStrategyResult",id:"postorpostsfetchstrategyresult",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Type declaration",id:"type-declaration-6",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"QueriedObject",id:"queriedobject",level:3},{value:"Type declaration",id:"type-declaration-7",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"Redirect",id:"redirect",level:3},{value:"Type declaration",id:"type-declaration-8",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"RedirectData",id:"redirectdata",level:3},{value:"Type declaration",id:"type-declaration-9",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"RedirectStrategy",id:"redirectstrategy",level:3},{value:"Defined in",id:"defined-in-25",level:4},{value:"isAnchorTagOptions",id:"isanchortagoptions",level:3},{value:"Type declaration",id:"type-declaration-10",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"isBlockOptions",id:"isblockoptions",level:3},{value:"Type declaration",id:"type-declaration-11",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"isImageTagOptions",id:"isimagetagoptions",level:3},{value:"Type declaration",id:"type-declaration-12",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"removeSourceUrlType",id:"removesourceurltype",level:3},{value:"Type declaration",id:"type-declaration-13",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"authorArchivesMatchers",id:"authorarchivesmatchers",level:3},{value:"Defined in",id:"defined-in-30",level:4},{value:"endpoints",id:"endpoints",level:3},{value:"Type declaration",id:"type-declaration-14",level:4},{value:"Defined in",id:"defined-in-31",level:4},{value:"ksesAllowedList",id:"ksesallowedlist",level:3},{value:"Defined in",id:"defined-in-32",level:4},{value:"postMatchers",id:"postmatchers",level:3},{value:"Defined in",id:"defined-in-33",level:4},{value:"postsMatchers",id:"postsmatchers",level:3},{value:"Defined in",id:"defined-in-34",level:4},{value:"searchMatchers",id:"searchmatchers",level:3},{value:"Defined in",id:"defined-in-35",level:4},{value:"youtubeEmbedRegex",id:"youtubeembedregex",level:3},{value:"Defined in",id:"defined-in-36",level:4},{value:"HTMLReactParser",id:"htmlreactparser",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-37",level:4},{value:"addQueryArgs",id:"addqueryargs",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-38",level:4},{value:"asyncForEach",id:"asyncforeach",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-39",level:4},{value:"attributesToProps",id:"attributestoprops",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"buildQueryString",id:"buildquerystring",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"decodeHtmlSpeciaChars",id:"decodehtmlspeciachars",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-42",level:4},{value:"domToReact",id:"domtoreact",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-43",level:4},{value:"fetchRedirect",id:"fetchredirect",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Defined in",id:"defined-in-44",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Returns",id:"returns-19",level:4},{value:"Defined in",id:"defined-in-45",level:4},{value:"getCustomPostType",id:"getcustomposttype",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"getCustomPostTypes",id:"getcustomposttypes",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"getCustomPostTypesSlugs",id:"getcustomposttypesslugs",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-22",level:4},{value:"Defined in",id:"defined-in-48",level:4},{value:"getCustomTaxonomies",id:"getcustomtaxonomies",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Defined in",id:"defined-in-49",level:4},{value:"getCustomTaxonomy",id:"getcustomtaxonomy",level:3},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-24",level:4},{value:"Defined in",id:"defined-in-50",level:4},{value:"getCustomTaxonomySlugs",id:"getcustomtaxonomyslugs",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Defined in",id:"defined-in-51",level:4},{value:"getHeadlessConfig",id:"getheadlessconfig",level:3},{value:"Returns",id:"returns-26",level:4},{value:"Defined in",id:"defined-in-52",level:4},{value:"getHeadstartWPConfig",id:"getheadstartwpconfig",level:3},{value:"Returns",id:"returns-27",level:4},{value:"Defined in",id:"defined-in-53",level:4},{value:"getHostUrl",id:"gethosturl",level:3},{value:"Returns",id:"returns-28",level:4},{value:"Defined in",id:"defined-in-54",level:4},{value:"getQueryArgs",id:"getqueryargs",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Defined in",id:"defined-in-55",level:4},{value:"getQueryString",id:"getquerystring",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Defined in",id:"defined-in-56",level:4},{value:"getSite",id:"getsite",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Defined in",id:"defined-in-57",level:4},{value:"getSiteByHost",id:"getsitebyhost",level:3},{value:"Parameters",id:"parameters-28",level:4},{value:"Returns",id:"returns-32",level:4},{value:"Defined in",id:"defined-in-58",level:4},{value:"getSiteBySourceUrl",id:"getsitebysourceurl",level:3},{value:"Parameters",id:"parameters-29",level:4},{value:"Returns",id:"returns-33",level:4},{value:"Defined in",id:"defined-in-59",level:4},{value:"getWPUrl",id:"getwpurl",level:3},{value:"Returns",id:"returns-34",level:4},{value:"Defined in",id:"defined-in-60",level:4},{value:"htmlToDOM",id:"htmltodom",level:3},{value:"Parameters",id:"parameters-30",level:4},{value:"Returns",id:"returns-35",level:4},{value:"Defined in",id:"defined-in-61",level:4},{value:"isElement",id:"iselement",level:3},{value:"Parameters",id:"parameters-31",level:4},{value:"Returns",id:"returns-36",level:4},{value:"Defined in",id:"defined-in-62",level:4},{value:"isExternalUrl",id:"isexternalurl",level:3},{value:"Parameters",id:"parameters-32",level:4},{value:"Returns",id:"returns-37",level:4},{value:"Defined in",id:"defined-in-63",level:4},{value:"isInternalLink",id:"isinternallink",level:3},{value:"Parameters",id:"parameters-33",level:4},{value:"Returns",id:"returns-38",level:4},{value:"Defined in",id:"defined-in-64",level:4},{value:"log",id:"log",level:3},{value:"Parameters",id:"parameters-34",level:4},{value:"Returns",id:"returns-39",level:4},{value:"Defined in",id:"defined-in-65",level:4},{value:"removeFieldsFromPostRelatedData",id:"removefieldsfrompostrelateddata",level:3},{value:"Parameters",id:"parameters-35",level:4},{value:"Returns",id:"returns-40",level:4},{value:"Defined in",id:"defined-in-66",level:4},{value:"removeSourceUrl",id:"removesourceurl",level:3},{value:"Parameters",id:"parameters-36",level:4},{value:"Returns",id:"returns-41",level:4},{value:"Defined in",id:"defined-in-67",level:4},{value:"setHeadlessConfig",id:"setheadlessconfig",level:3},{value:"Parameters",id:"parameters-37",level:4},{value:"Returns",id:"returns-42",level:4},{value:"Defined in",id:"defined-in-68",level:4},{value:"setHeadstartWPConfig",id:"setheadstartwpconfig",level:3},{value:"Parameters",id:"parameters-38",level:4},{value:"Returns",id:"returns-43",level:4},{value:"Defined in",id:"defined-in-69",level:4},{value:"stripTags",id:"striptags",level:3},{value:"Parameters",id:"parameters-39",level:4},{value:"Returns",id:"returns-44",level:4},{value:"Defined in",id:"defined-in-70",level:4},{value:"warn",id:"warn",level:3},{value:"Parameters",id:"parameters-40",level:4},{value:"Returns",id:"returns-45",level:4},{value:"Defined in",id:"defined-in-71",level:4},{value:"Utility Functions",id:"utility-functions",level:2},{value:"parsePath",id:"parsepath",level:3},{value:"Parameters",id:"parameters-41",level:4},{value:"Returns",id:"returns-46",level:4},{value:"Defined in",id:"defined-in-72",level:4}],s={toc:o};function m(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"namespaces"},"Namespaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/namespaces/headstartwp_core.react"},"react"))),(0,r.kt)("h2",{id:"enumerations"},"Enumerations"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/enums/headstartwp_core.LOGTYPE"},"LOGTYPE"))),(0,r.kt)("h2",{id:"classes"},"Classes"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.AppSettingsStrategy"},"AppSettingsStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy"},"AuthorArchiveFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.Comment"},"Comment")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.ConfigError"},"ConfigError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.Element"},"Element")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.EndpointError"},"EndpointError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.FetchError"},"FetchError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.FrameworkError"},"FrameworkError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.NotFoundError"},"NotFoundError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy"},"PostOrPostsFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.ProcessingInstruction"},"ProcessingInstruction")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.SearchFetchStrategy"},"SearchFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"},"SinglePostFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy"},"TaxonomyTermsStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.Text"},"Text")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy"},"VerifyTokenFetchStrategy"))),(0,r.kt)("h2",{id:"interfaces"},"Interfaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},"AppEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.AttachmentEntity"},"AttachmentEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},"AuthorEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.AvatarUrls"},"AvatarUrls")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.CommentEntity"},"CommentEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},"FetchOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},"FetchResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},"FilterDataOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"},"HTMLReactParserOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.Integration"},"Integration")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},"MenuItemEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PageEntity"},"PageEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},"PageInfo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PolylangIntegration"},"PolylangIntegration")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},"PostEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},"PostOrPostsParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostParams"},"PostParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},"PostsArchiveParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.Rendered"},"Rendered")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.RevisionEntity"},"RevisionEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.SearchEntity"},"SearchEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},"TaxonomyArchiveParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.TaxonomyEntity"},"TaxonomyEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},"TermEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.TypeEntity"},"TypeEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"},"VerifyTokenParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration"},"YoastSEOIntegration"))),(0,r.kt)("h2",{id:"dom-helpers"},"DOM Helpers"),(0,r.kt)("h3",{id:"isanchortag"},"isAnchorTag"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isAnchorTag"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): node is Element"),(0,r.kt)("p",null,"Checks if the provided node is an valid anchor tag"),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h2",{id:"usage"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isAnchorTag } from '@headstartwp/core';\nimport { LinkBlock } from '@10up/headless-next';\n\n\n isAnchorTag(node, { isInternalLink: true})} />\n\n")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#isanchortagoptions"},(0,r.kt)("inlineCode",{parentName:"a"},"isAnchorTagOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Supported options")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,"node is Element"),(0,r.kt)("p",null,"Whether it's an anchor tag according to the options passed"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/dom/index.ts#L77"},"packages/core/src/dom/index.ts:77")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isblock"},"isBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"_options"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Tests a node by tagName and/or className"),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h2",{id:"usage-1"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isBlock } from '@headstartwp/core';\n\n\n isBlock(node, { tagName: 'div', classList: ['block-class-name'] })}\n />\n\n")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"_options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#isblockoptions"},(0,r.kt)("inlineCode",{parentName:"a"},"isBlockOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"true if the node passes the test"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/dom/index.ts#L278"},"packages/core/src/dom/index.ts:278")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isblockbyname"},"isBlockByName"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isBlockByName"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"name"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Tests a node by block name. This requires the Headless WP Plugin to be installed."),(0,r.kt)("p",null,"The Headless WP Plugin will append ",(0,r.kt)("inlineCode",{parentName:"p"},"data-wp-block-name")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"data-wp-block")," to every block,\nthis function relies on those attributes to determine if the node is a block."),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h2",{id:"usage-2"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isBlockByName } from '@headstartwp/core';\n\n\n isBlock(node, 'core/paragraph')}\n />\n\n")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The block name")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"true if the node passes the test"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/dom/index.ts#L334"},"packages/core/src/dom/index.ts:334")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isimagetag"},"isImageTag"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isImageTag"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Checks if the provided node is an valid image tag"),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h2",{id:"usage-3"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isImageTag, ImageBlock } from '@headstartwp/core';\nimport { ImageComponent } from '@10up/headless-next';\n\n\n isImageTag(node, { hasDimensions: true})}\n component={ImageComponent}\n />\n\n")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#isimagetagoptions"},(0,r.kt)("inlineCode",{parentName:"a"},"isImageTagOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Supported options.")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Whether it's an image tag or not according to the options passed"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/dom/index.ts#L141"},"packages/core/src/dom/index.ts:141")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"istwitterembed"},"isTwitterEmbed"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isTwitterEmbed"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Checks if the node is an twitter embed"),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h2",{id:"usage-4"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isTwitterEmbed } from '@headstartwp/core';\n\n\n \n\n")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"true if the node is a twitter embed"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/dom/index.ts#L227"},"packages/core/src/dom/index.ts:227")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isyoutubeembed"},"isYoutubeEmbed"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isYoutubeEmbed"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Checks if the node is an youtube embed"),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h2",{id:"usage-5"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isYoutubeEmbed } from '@headstartwp/core';\n\n\n \n\n")),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"true if the node is a youtube embed"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/dom/index.ts#L187"},"packages/core/src/dom/index.ts:187")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"wpksespost"},"wpKsesPost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"wpKsesPost"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"content"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"allowList?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Sanitize HTML content by the wp_kses_post() requirements"),(0,r.kt)("h2",{id:"usage-6"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { wpKsesPost } from '@headstartwp/core';\nwpKsesPost(html);\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://codex.wordpress.org/Function_Reference/wp_kses_post"},"https://codex.wordpress.org/Function_Reference/wp_kses_post")),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"content")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The content to sanitize.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"allowList?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"IWhiteList")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Optional. The list of allowed HTML tags and attributes. If not set, the default allow list will be used.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"IWpKsesPostOptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Optional. IWpKsesPostOptions.")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Sanitized string of HTML."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/dom/wpKsesPost.ts#L30"},"packages/core/src/dom/wpKsesPost.ts:30")),(0,r.kt)("h2",{id:"data-fetching"},"Data Fetching"),(0,r.kt)("h3",{id:"apiget"},"apiGet"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"apiGet"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"args?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"burstCache?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"headers"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"[index: string]"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"; } = receivedHeaders; ",(0,r.kt)("inlineCode",{parentName:"p"},"json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," }",">"),(0,r.kt)("p",null,"Fetch Wrapper to handle GET requests."),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The URL where to make the request to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The arguments")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"burstCache")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether it should burst cache")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"headers"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"[index: string]"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"; } = receivedHeaders; ",(0,r.kt)("inlineCode",{parentName:"p"},"json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," }",">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/api/fetch-utils.ts#L46"},"packages/core/src/data/api/fetch-utils.ts:46")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"apipost"},"apiPost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"apiPost"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"args?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Fetch Wrapper to handle POST requests"),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The URL where to make the request to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The arguments")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/api/fetch-utils.ts#L17"},"packages/core/src/data/api/fetch-utils.ts:17")),(0,r.kt)("h2",{id:"data-handling"},"Data Handling"),(0,r.kt)("h3",{id:"getpostauthor"},"getPostAuthor"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getPostAuthor"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"post"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,r.kt)("p",null,"Returns the author object from the post object if it exists"),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"post")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Post object")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/utils/postHandling.ts#L11"},"packages/core/src/data/utils/postHandling.ts:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getpostterms"},"getPostTerms"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getPostTerms"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"post"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,r.kt)("p",null,"Returns the terms associated with the post"),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"post")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Post object")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/utils/postHandling.ts#L22"},"packages/core/src/data/utils/postHandling.ts:22")),(0,r.kt)("h2",{id:"other"},"Other"),(0,r.kt)("h3",{id:"customposttype"},"CustomPostType"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"CustomPostType"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"archive?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"matchSinglePath?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether this custom post type should match the archive path If set to true, then when querying a post type archive page such as ",(0,r.kt)("inlineCode",{parentName:"td"},"/[post-type]/[post-name]")," the ",(0,r.kt)("inlineCode",{parentName:"td"},"post.link")," property should match the current path. This will avoid matching nested posts/pages that doesn't exist for instance: ",(0,r.kt)("inlineCode",{parentName:"td"},"/[post-type]/fake-parent-page/[post-name]")," will not match if this option is set to true even though ",(0,r.kt)("inlineCode",{parentName:"td"},"post-name")," exists. It is strongly recommended to set this option to true, otherwise hierarchical post types (such as pages) will not work properly. ",(0,r.kt)("strong",{parentName:"td"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))," true")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"single?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/types.ts#L1"},"packages/core/src/types.ts:1")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"customposttypes"},"CustomPostTypes"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"CustomPostTypes"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customposttype"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostType")),"[]"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/types.ts#L21"},"packages/core/src/types.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"customtaxonomies"},"CustomTaxonomies"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"CustomTaxonomies"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customtaxonomy"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomy")),"[]"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/types.ts#L43"},"packages/core/src/types.ts:43")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"customtaxonomy"},"CustomTaxonomy"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"CustomTaxonomy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"matchArchivePath?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether this custom taxonomy should match the archive path If set to true, then when querying a taxonomy archive page such as ",(0,r.kt)("inlineCode",{parentName:"td"},"/[taxonmy-slug]/[term-slug]")," the ",(0,r.kt)("inlineCode",{parentName:"td"},"term.link")," property should match the current path. This will avoid matching nested categories that doesn't exist for instance: ",(0,r.kt)("inlineCode",{parentName:"td"},"/[taxonmy-slug]/fake-parent-term/[term-slug]")," will not match if this option is set to true even though ",(0,r.kt)("inlineCode",{parentName:"td"},"term-slug")," exists. ",(0,r.kt)("strong",{parentName:"td"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))," false")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"restParam?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"rewrite?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/types.ts#L25"},"packages/core/src/types.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"DOMNode"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"DOMNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Comment"},(0,r.kt)("inlineCode",{parentName:"a"},"Comment"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Node")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.ProcessingInstruction"},(0,r.kt)("inlineCode",{parentName:"a"},"ProcessingInstruction"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Text"},(0,r.kt)("inlineCode",{parentName:"a"},"Text"))),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-react-parser/index.d.ts:21"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"htmlparser2options"},"HTMLParser2Options"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HTMLParser2Options"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ParserOptions")," & ",(0,r.kt)("inlineCode",{parentName:"p"},"DomHandlerOptions")),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-react-parser/index.d.ts:19"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headlessconfig"},"HeadlessConfig"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessConfig"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customPostTypes?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes"))," ","|"," (",(0,r.kt)("inlineCode",{parentName:"td"},"defaultPostTypes"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes")),") => ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customTaxonomies?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies"))," ","|"," (",(0,r.kt)("inlineCode",{parentName:"td"},"defaultTaxonomies"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies")),") => ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"devMode?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"redirects?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"requests?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug.devMode?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug.redirects?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug.requests?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"host?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hostUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"integrations?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#integrations"},(0,r.kt)("inlineCode",{parentName:"a"},"Integrations")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"locale?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirectStrategy?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#redirectstrategy"},(0,r.kt)("inlineCode",{parentName:"a"},"RedirectStrategy")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sites?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"useWordPressPlugin?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/types.ts#L58"},"packages/core/src/types.ts:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"integrations"},"Integrations"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Integrations"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"polylang?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PolylangIntegration"},(0,r.kt)("inlineCode",{parentName:"a"},"PolylangIntegration")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"yoastSEO?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration"},(0,r.kt)("inlineCode",{parentName:"a"},"YoastSEOIntegration")))))),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/types.ts#L53"},"packages/core/src/types.ts:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"matcher"},"Matcher"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Matcher"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-4"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pattern")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"priority")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/utils/matchers.ts#L1"},"packages/core/src/data/utils/matchers.ts:1")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"normalizeddataforcache"},"NormalizedDataForCache"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"NormalizedDataForCache"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P"))))),(0,r.kt)("h4",{id:"type-declaration-5"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"additionalCacheObjects?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,r.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">","[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"url"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key.args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key.url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L83"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:83")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"postorpostsfetchstrategyresult"},"PostOrPostsFetchStrategyResult"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"PostOrPostsFetchStrategyResult"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))))),(0,r.kt)("h4",{id:"type-declaration-6"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isSingle")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L42"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:42")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"queriedobject"},"QueriedObject"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"QueriedObject"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The QueriedObject represents the object that the current requests is subjected to."),(0,r.kt)("p",null,"Querying by taxonomy and/or author will set the queried object."),(0,r.kt)("h4",{id:"type-declaration-7"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"author?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the request is an author query, this will be populated with the author object")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"search?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.SearchEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"SearchEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the request is a search query, this will be populated with the search entity object")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"term?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the request is a term query, this will be populated with the term object")))),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L707"},"packages/core/src/data/types/entities.ts:707")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"redirect"},"Redirect"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Redirect"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-8"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ID")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"enable_regex")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"post_status")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirect_from")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirect_to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"status_code")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L647"},"packages/core/src/data/types/entities.ts:647")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"redirectdata"},"RedirectData"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"RedirectData"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-9"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"location")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"null")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The redirect new location will be null if no redirect is found")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"status")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The status number of the redirect Will be 0 if the redirect is not found")))),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/fetchRedirect.ts#L5"},"packages/core/src/utils/fetchRedirect.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"redirectstrategy"},"RedirectStrategy"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"RedirectStrategy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"404"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"none"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"always"')),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/types.ts#L23"},"packages/core/src/types.ts:23")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isanchortagoptions"},"isAnchorTagOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"isAnchorTagOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-10"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isInternalLink?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},'If true, will check if the anchor tag contains a valid internal link. if target="_blank" then this option is not taken into account')))),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/dom/index.ts#L5"},"packages/core/src/dom/index.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isblockoptions"},"isBlockOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"isBlockOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-11"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"className?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"A single or array of classNames to check for If an array of class names is passed, the block will be considered valid if all of the class names are found")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tagName?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The tagName to check for")))),(0,r.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/dom/index.ts#L238"},"packages/core/src/dom/index.ts:238")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isimagetagoptions"},"isImageTagOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"isImageTagOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-12"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hasDimensions?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If true, will check if the image tag contains width and height attributes")))),(0,r.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/dom/index.ts#L107"},"packages/core/src/dom/index.ts:107")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removesourceurltype"},"removeSourceUrlType"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"removeSourceUrlType"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-13"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"backendUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The backend url.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"link")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The link url, possibly with the source url.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"publicUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The public url. Defaults to '/'.")))),(0,r.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/removeSourceUrl.ts#L3"},"packages/core/src/utils/removeSourceUrl.ts:3")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"authorarchivesmatchers"},"authorArchivesMatchers"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"authorArchivesMatchers"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#matcher"},(0,r.kt)("inlineCode",{parentName:"a"},"Matcher")),"[]"),(0,r.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/utils/matchers.ts#L43"},"packages/core/src/data/utils/matchers.ts:43")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"endpoints"},"endpoints"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"endpoints"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-14"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"appSettings")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"category")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pages")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"posts")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tags")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tokenVerify")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"yoast")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/endpoints.ts#L1"},"packages/core/src/utils/endpoints.ts:1")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ksesallowedlist"},"ksesAllowedList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"ksesAllowedList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"IWhiteList")),(0,r.kt)("p",null,"Default Allowed HTML Attributes"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://codex.wordpress.org/Function_Reference/wp_kses_post"},"https://codex.wordpress.org/Function_Reference/wp_kses_post")),(0,r.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/dom/wpKsesPost.ts#L266"},"packages/core/src/dom/wpKsesPost.ts:266")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"postmatchers"},"postMatchers"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"postMatchers"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#matcher"},(0,r.kt)("inlineCode",{parentName:"a"},"Matcher")),"[]"),(0,r.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/utils/matchers.ts#L7"},"packages/core/src/data/utils/matchers.ts:7")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"postsmatchers"},"postsMatchers"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"postsMatchers"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#matcher"},(0,r.kt)("inlineCode",{parentName:"a"},"Matcher")),"[]"),(0,r.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/utils/matchers.ts#L20"},"packages/core/src/data/utils/matchers.ts:20")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"searchmatchers"},"searchMatchers"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"searchMatchers"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#matcher"},(0,r.kt)("inlineCode",{parentName:"a"},"Matcher")),"[]"),(0,r.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/utils/matchers.ts#L56"},"packages/core/src/data/utils/matchers.ts:56")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"youtubeembedregex"},"youtubeEmbedRegex"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"youtubeEmbedRegex"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"RegExp")),(0,r.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/dom/index.ts#L160"},"packages/core/src/dom/index.ts:160")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"htmlreactparser"},"HTMLReactParser"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"HTMLReactParser"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"html"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"ReturnType"),""),(0,r.kt)("p",null,"Converts HTML string to JSX element(s)."),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"html")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"HTML string.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"HTMLReactParserOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Parser options.")))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"ReturnType"),""),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"JSX element(s), empty array, or string.")),(0,r.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-react-parser/index.d.ts:51"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"addqueryargs"},"addQueryArgs"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addQueryArgs"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"args"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/url.ts#L167"},"packages/core/src/utils/url.ts:167")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"asyncforeach"},"asyncForEach"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"asyncForEach"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"array"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"callback"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"array")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"callback")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"el"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"index"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"array"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]) => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/asyncForEach.ts#L1"},"packages/core/src/utils/asyncForEach.ts:1")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"attributestoprops"},"attributesToProps"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"attributesToProps"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"attributes"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"nodeName?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Props")),(0,r.kt)("p",null,"Converts HTML/SVG DOM attributes to React props."),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"attributes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Attributes")),(0,r.kt)("td",{parentName:"tr",align:"left"},"HTML/SVG DOM attributes.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nodeName?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"DOM node name.")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Props")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"React props.")),(0,r.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-react-parser/lib/attributes-to-props.d.ts:17"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"buildquerystring"},"buildQueryString"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"buildQueryString"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Generates URL-encoded query string using input query data."),(0,r.kt)("p",null,"It is intended to behave equivalent as PHP's ",(0,r.kt)("inlineCode",{parentName:"p"},"http_build_query"),", configured\nwith encoding type PHP_QUERY_RFC3986 (spaces as ",(0,r.kt)("inlineCode",{parentName:"p"},"%20"),")."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const queryString = buildQueryString( {\n simple: 'is ok',\n arrays: [ 'are', 'fine', 'too' ],\n objects: {\n evenNested: {\n ok: 'yes',\n },\n },\n} );\n// \"simple=is%20ok&arrays%5B0%5D=are&arrays%5B1%5D=fine&arrays%5B2%5D=too&objects%5BevenNested%5D%5Bok%5D=yes\"\n")),(0,r.kt)("h4",{id:"parameters-15"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Data to encode.")))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Query string."),(0,r.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/url.ts#L129"},"packages/core/src/utils/url.ts:129")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"decodehtmlspeciachars"},"decodeHtmlSpeciaChars"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"decodeHtmlSpeciaChars"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"text"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Decodes HTML special chars entities"),(0,r.kt)("h4",{id:"parameters-16"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The text we want to decode")))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"text with decoded html entities"),(0,r.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/decodeHtmlSpeciaChars.ts#L8"},"packages/core/src/utils/decodeHtmlSpeciaChars.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domtoreact"},"domToReact"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"domToReact"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"nodes"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element"),"[]"),(0,r.kt)("p",null,"Converts DOM nodes to JSX element(s)."),(0,r.kt)("h4",{id:"parameters-17"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nodes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"DOM nodes.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"HTMLReactParserOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Parser options.")))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element"),"[]"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"JSX element(s).")),(0,r.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-react-parser/lib/dom-to-react.d.ts:15"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchredirect"},"fetchRedirect"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchRedirect"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"pathname"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#redirectdata"},(0,r.kt)("inlineCode",{parentName:"a"},"RedirectData")),">"),(0,r.kt)("p",null,"Fetches a redirect from the WordPress origin by making a HEAD request and checking the response"),(0,r.kt)("h4",{id:"parameters-18"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pathname")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path to the page to fetch the redirect for")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The source url")))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#redirectdata"},(0,r.kt)("inlineCode",{parentName:"a"},"RedirectData")),">"),(0,r.kt)("p",null,"The redirect data"),(0,r.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/fetchRedirect.ts#L51"},"packages/core/src/utils/fetchRedirect.ts:51")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAuthHeader"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/api/fetch-utils.ts#L3"},"packages/core/src/data/api/fetch-utils.ts:3")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomposttype"},"getCustomPostType"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomPostType"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"slug"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customposttype"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostType"))),(0,r.kt)("p",null,"Returns a single post type by slug if defined"),(0,r.kt)("h4",{id:"parameters-19"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"post type slug")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns-20"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customposttype"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostType"))),(0,r.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/config.ts#L248"},"packages/core/src/utils/config.ts:248")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomposttypes"},"getCustomPostTypes"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomPostTypes"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes"))),(0,r.kt)("p",null,"Returns the available post types"),(0,r.kt)("h4",{id:"parameters-20"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-21"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes"))),(0,r.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/config.ts#L225"},"packages/core/src/utils/config.ts:225")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomposttypesslugs"},"getCustomPostTypesSlugs"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomPostTypesSlugs"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Returns the available post type slugs"),(0,r.kt)("h4",{id:"parameters-21"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-22"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/config.ts#L236"},"packages/core/src/utils/config.ts:236")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomtaxonomies"},"getCustomTaxonomies"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomTaxonomies"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies"))),(0,r.kt)("p",null,"Returns the available taxonomies"),(0,r.kt)("h4",{id:"parameters-22"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-23"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies"))),(0,r.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/config.ts#L185"},"packages/core/src/utils/config.ts:185")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomtaxonomy"},"getCustomTaxonomy"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomTaxonomy"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"slug"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customtaxonomy"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomy"))),(0,r.kt)("p",null,"Returns a single post type by slug if defined"),(0,r.kt)("h4",{id:"parameters-23"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"post type slug")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns-24"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customtaxonomy"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomy"))),(0,r.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/config.ts#L214"},"packages/core/src/utils/config.ts:214")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomtaxonomyslugs"},"getCustomTaxonomySlugs"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomTaxonomySlugs"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Returns the available taxonomy slugs"),(0,r.kt)("h4",{id:"parameters-24"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-25"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/config.ts#L197"},"packages/core/src/utils/config.ts:197")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getheadlessconfig"},"getHeadlessConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getHeadlessConfig"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Returns the contents of headless.config.js"),(0,r.kt)("p",null,"This function requires framework integration in order to work. The contents of ",(0,r.kt)("inlineCode",{parentName:"p"},"headless.config.js"),"\nneeds to be injected at build time into a global variable."),(0,r.kt)("p",null,"Make sure you are using one of the framework's integration (such as next) before using this function."),(0,r.kt)("h4",{id:"returns-26"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The contents of headless.config.js"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customPostTypes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customTaxonomies")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"td"},"devMode?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"redirects?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"requests?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hostUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"integrations")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#integrations"},(0,r.kt)("inlineCode",{parentName:"a"},"Integrations")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirectStrategy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#redirectstrategy"},(0,r.kt)("inlineCode",{parentName:"a"},"RedirectStrategy")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sites")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"useWordPressPlugin")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/config.ts#L22"},"packages/core/src/utils/config.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getheadstartwpconfig"},"getHeadstartWPConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getHeadstartWPConfig"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Returns the contents of headless.config.js"),(0,r.kt)("p",null,"This function requires framework integration in order to work. The contents of ",(0,r.kt)("inlineCode",{parentName:"p"},"headless.config.js"),"\nneeds to be injected at build time into a global variable."),(0,r.kt)("p",null,"Make sure you are using one of the framework's integration (such as next) before using this function."),(0,r.kt)("h4",{id:"returns-27"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The contents of headless.config.js"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customPostTypes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customTaxonomies")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"td"},"devMode?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"redirects?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"requests?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hostUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"integrations")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#integrations"},(0,r.kt)("inlineCode",{parentName:"a"},"Integrations")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirectStrategy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#redirectstrategy"},(0,r.kt)("inlineCode",{parentName:"a"},"RedirectStrategy")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sites")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"useWordPressPlugin")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-53"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/config.ts#L22"},"packages/core/src/utils/config.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"gethosturl"},"getHostUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getHostUrl"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the WP URL based on the headless config"),(0,r.kt)("h4",{id:"returns-28"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-54"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/config.ts#L265"},"packages/core/src/utils/config.ts:265")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getqueryargs"},"getQueryArgs"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getQueryArgs"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Returns an object of query arguments of the given URL. If the given URL is\ninvalid or has no querystring, an empty object is returned."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},'const foo = getQueryArgs( \'https://wordpress.org?foo=bar&bar=baz\' );\n// { "foo": "bar", "bar": "baz" }\n')),(0,r.kt)("h4",{id:"parameters-25"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"URL.")))),(0,r.kt)("h4",{id:"returns-29"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Query args object."),(0,r.kt)("h4",{id:"defined-in-55"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/url.ts#L78"},"packages/core/src/utils/url.ts:78")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getquerystring"},"getQueryString"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getQueryString"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"parameters-26"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-30"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"defined-in-56"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/url.ts#L49"},"packages/core/src/utils/url.ts:49")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsite"},"getSite"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSite"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("p",null,"Get a config for a specific site"),(0,r.kt)("h4",{id:"parameters-27"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h4",{id:"returns-31"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("h4",{id:"defined-in-57"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/config.ts#L111"},"packages/core/src/utils/config.ts:111")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsitebyhost"},"getSiteByHost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSiteByHost"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"hostOrUrl"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"locale?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("p",null,"Finds a site by host and optionally locale"),(0,r.kt)("h4",{id:"parameters-28"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hostOrUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The hostname")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"locale?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns-32"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("h4",{id:"defined-in-58"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/config.ts#L135"},"packages/core/src/utils/config.ts:135")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsitebysourceurl"},"getSiteBySourceUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSiteBySourceUrl"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("p",null,"Get a site by source url"),(0,r.kt)("h4",{id:"parameters-29"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-33"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("p",null,"HeadlessConfig"),(0,r.kt)("h4",{id:"defined-in-59"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/config.ts#L173"},"packages/core/src/utils/config.ts:173")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getwpurl"},"getWPUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getWPUrl"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the WP URL based on the headless config"),(0,r.kt)("h4",{id:"returns-34"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-60"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/config.ts#L257"},"packages/core/src/utils/config.ts:257")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"htmltodom"},"htmlToDOM"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"htmlToDOM"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"html"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): (",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Comment"},(0,r.kt)("inlineCode",{parentName:"a"},"Comment"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.ProcessingInstruction"},(0,r.kt)("inlineCode",{parentName:"a"},"ProcessingInstruction"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Text"},(0,r.kt)("inlineCode",{parentName:"a"},"Text")),")[]"),(0,r.kt)("p",null,"Parses HTML string to DOM nodes in Node.js."),(0,r.kt)("p",null,"This is the same method as ",(0,r.kt)("inlineCode",{parentName:"p"},"require('htmlparser2').parseDOM"),"\n",(0,r.kt)("a",{parentName:"p",href:"https://github.com/fb55/htmlparser2/blob/v6.0.0/src/index.ts#L29-L41"},"https://github.com/fb55/htmlparser2/blob/v6.0.0/src/index.ts#L29-L41")),(0,r.kt)("h4",{id:"parameters-30"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"html")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"HTML markup.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"DomHandlerOptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Parser options (",(0,r.kt)("a",{parentName:"td",href:"https://github.com/fb55/domhandler/tree/v5.0.3#readme"},"https://github.com/fb55/domhandler/tree/v5.0.3#readme"),").")))),(0,r.kt)("h4",{id:"returns-35"},"Returns"),(0,r.kt)("p",null,"(",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Comment"},(0,r.kt)("inlineCode",{parentName:"a"},"Comment"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.ProcessingInstruction"},(0,r.kt)("inlineCode",{parentName:"a"},"ProcessingInstruction"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Text"},(0,r.kt)("inlineCode",{parentName:"a"},"Text")),")[]"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"DOM nodes.")),(0,r.kt)("h4",{id:"defined-in-61"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-dom-parser/lib/server/html-to-dom.d.ts:21"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"iselement"},"isElement"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isElement"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): node is Element"),(0,r.kt)("p",null,"Checks if the node is an Element."),(0,r.kt)("p",null,"We rely on this function to avoid issues with instanceof."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/issues/504"},"https://github.com/10up/headstartwp/issues/504")),(0,r.kt)("h4",{id:"parameters-31"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The dom node")))),(0,r.kt)("h4",{id:"returns-36"},"Returns"),(0,r.kt)("p",null,"node is Element"),(0,r.kt)("p",null,"Whether the node is of type element or not"),(0,r.kt)("h4",{id:"defined-in-62"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/dom/index.ts#L25"},"packages/core/src/dom/index.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isexternalurl"},"isExternalUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isExternalUrl"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"link"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Checks if the provided link is an external Url."),(0,r.kt)("p",null,"Inspired on the Frontity implementation"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts"},"https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts")),(0,r.kt)("h4",{id:"parameters-32"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"link")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The link Url.")))),(0,r.kt)("h4",{id:"returns-37"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"True if the link is an external Url."),(0,r.kt)("h4",{id:"defined-in-63"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/isExternalUrl.ts#L12"},"packages/core/src/utils/isExternalUrl.ts:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isinternallink"},"isInternalLink"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isInternalLink"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Checks if the url is for an internal link"),(0,r.kt)("h4",{id:"parameters-33"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The url to check")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"(optional) the site config")))),(0,r.kt)("h4",{id:"returns-38"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-64"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/isInternalLink.ts#L14"},"packages/core/src/utils/isInternalLink.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"log"},"log"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"log"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"type"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"...args"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-34"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"type")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/headstartwp_core.LOGTYPE"},(0,r.kt)("inlineCode",{parentName:"a"},"LOGTYPE")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"...args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]")))),(0,r.kt)("h4",{id:"returns-39"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-65"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/log.ts#L9"},"packages/core/src/utils/log.ts:9")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removefieldsfrompostrelateddata"},"removeFieldsFromPostRelatedData"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeFieldsFromPostRelatedData"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fieldsToRemove"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"post"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"_embedded"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"author"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wp:featuredmedia"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wp:term"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]"," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"categories?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"comment_status?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"closed"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"content"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"date"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"date_gmt"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"excerpt"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"featured_media"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"format"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"link"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"status"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"standard"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"aside"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"chat"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"gallery"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"image"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"quote"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"video"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"audio"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"guid"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"modified"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"modified_gmt"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"ping_status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"closed"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"private"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sticky"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"tags?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"template"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"terms?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"title"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head_json?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," }"),(0,r.kt)("h4",{id:"parameters-35"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fieldsToRemove")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"number"),")[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"post")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))))),(0,r.kt)("h4",{id:"returns-40"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"_embedded"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"author"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wp:featuredmedia"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wp:term"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]"," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"categories?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"comment_status?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"closed"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"content"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"date"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"date_gmt"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"excerpt"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"featured_media"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"format"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"link"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"status"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"standard"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"aside"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"chat"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"gallery"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"image"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"quote"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"video"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"audio"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"guid"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"modified"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"modified_gmt"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"ping_status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"closed"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"private"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sticky"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"tags?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"template"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"terms?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"title"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head_json?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," }"),(0,r.kt)("h4",{id:"defined-in-66"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/utils/postHandling.ts#L47"},"packages/core/src/data/utils/postHandling.ts:47")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removesourceurl"},"removeSourceUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeSourceUrl"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Make the link relative if it belongs to the backend, to force client-side\nnavigation."),(0,r.kt)("p",null,"Inspired on the Frontity implementation"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts"},"https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts")),(0,r.kt)("h4",{id:"parameters-36"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#removesourceurltype"},(0,r.kt)("inlineCode",{parentName:"a"},"removeSourceUrlType")))))),(0,r.kt)("h4",{id:"returns-41"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The URL without the Source URL."),(0,r.kt)("h4",{id:"defined-in-67"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/removeSourceUrl.ts#L30"},"packages/core/src/utils/removeSourceUrl.ts:30")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setheadlessconfig"},"setHeadlessConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setHeadlessConfig"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-37"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h4",{id:"returns-42"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-68"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/config.ts#L6"},"packages/core/src/utils/config.ts:6")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setheadstartwpconfig"},"setHeadstartWPConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setHeadstartWPConfig"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-38"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h4",{id:"returns-43"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-69"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/config.ts#L6"},"packages/core/src/utils/config.ts:6")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"striptags"},"stripTags"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"stripTags"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"html"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("p",null,"Utility functions to strip any tags"),(0,r.kt)("h4",{id:"parameters-39"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"html")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The html string")))),(0,r.kt)("h4",{id:"returns-44"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"defined-in-70"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/dom/stripTags.ts#L8"},"packages/core/src/dom/stripTags.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"warn"},"warn"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"warn"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"message"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Logs a warning in the console in dev mode"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},'warn("You should do/change something.")\n')),(0,r.kt)("h4",{id:"parameters-40"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The message that describes the warning.")))),(0,r.kt)("h4",{id:"returns-45"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-71"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/errors.ts#L45"},"packages/core/src/utils/errors.ts:45")),(0,r.kt)("h2",{id:"utility-functions"},"Utility Functions"),(0,r.kt)("h3",{id:"parsepath"},"parsePath"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"parsePath"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"matchers"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Parses a path and extracts the parameters from it"),(0,r.kt)("h4",{id:"parameters-41"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"matchers")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#matcher"},(0,r.kt)("inlineCode",{parentName:"a"},"Matcher")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"An array of Matchers")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path")))),(0,r.kt)("h4",{id:"returns-46"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"the extracted parameters"),(0,r.kt)("h4",{id:"defined-in-72"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/utils/parsePath.ts#L46"},"packages/core/src/data/utils/parsePath.ts:46")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/0f4f470d.c76ec246.js b/assets/js/0f4f470d.9f672f3a.js similarity index 95% rename from assets/js/0f4f470d.c76ec246.js rename to assets/js/0f4f470d.9f672f3a.js index 4fb69faeb..3bdd59a7c 100644 --- a/assets/js/0f4f470d.c76ec246.js +++ b/assets/js/0f4f470d.9f672f3a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9050],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function l(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(r),u=n,m=s["".concat(p,".").concat(u)]||s[u]||k[u]||l;return r?a.createElement(m,i(i({ref:t},d),{},{components:r})):a.createElement(m,i({ref:t},d))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=r.length,i=new Array(l);i[0]=u;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const l={id:"headstartwp_core.react.PullQuoteBlockProps",title:"Interface: PullQuoteBlockProps",sidebar_label:"@headstartwp/core.react.PullQuoteBlockProps",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.PullQuoteBlockProps",id:"interfaces/headstartwp_core.react.PullQuoteBlockProps",title:"Interface: PullQuoteBlockProps",description:"@headstartwp/core.react.PullQuoteBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.PullQuoteBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.PullQuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.PullQuoteBlockProps",title:"Interface: PullQuoteBlockProps",sidebar_label:"@headstartwp/core.react.PullQuoteBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.PreformattedBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},next:{title:"@headstartwp/core.react.QuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"borderColor",id:"bordercolor",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"cite",id:"cite",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"quote",id:"quote",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".PullQuoteBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PullQuoteBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"bordercolor"},"borderColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"borderColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/PullQuote.tsx#L10"},"packages/core/src/react/blocks/PullQuote.tsx:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"cite"},"cite"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"cite"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/PullQuote.tsx#L9"},"packages/core/src/react/blocks/PullQuote.tsx:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"quote"},"quote"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"quote"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/PullQuote.tsx#L8"},"packages/core/src/react/blocks/PullQuote.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9050],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function l(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(r),u=n,m=s["".concat(p,".").concat(u)]||s[u]||k[u]||l;return r?a.createElement(m,i(i({ref:t},d),{},{components:r})):a.createElement(m,i({ref:t},d))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=r.length,i=new Array(l);i[0]=u;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const l={id:"headstartwp_core.react.PullQuoteBlockProps",title:"Interface: PullQuoteBlockProps",sidebar_label:"@headstartwp/core.react.PullQuoteBlockProps",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.PullQuoteBlockProps",id:"interfaces/headstartwp_core.react.PullQuoteBlockProps",title:"Interface: PullQuoteBlockProps",description:"@headstartwp/core.react.PullQuoteBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.PullQuoteBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.PullQuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.PullQuoteBlockProps",title:"Interface: PullQuoteBlockProps",sidebar_label:"@headstartwp/core.react.PullQuoteBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.PreformattedBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},next:{title:"@headstartwp/core.react.QuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"borderColor",id:"bordercolor",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"cite",id:"cite",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"quote",id:"quote",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".PullQuoteBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PullQuoteBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"bordercolor"},"borderColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"borderColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/PullQuote.tsx#L10"},"packages/core/src/react/blocks/PullQuote.tsx:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"cite"},"cite"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"cite"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/PullQuote.tsx#L9"},"packages/core/src/react/blocks/PullQuote.tsx:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"quote"},"quote"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"quote"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/PullQuote.tsx#L8"},"packages/core/src/react/blocks/PullQuote.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/0f7b7d82.c4ac105a.js b/assets/js/0f7b7d82.281cf258.js similarity index 93% rename from assets/js/0f7b7d82.c4ac105a.js rename to assets/js/0f7b7d82.281cf258.js index 859922536..0eaf498ae 100644 --- a/assets/js/0f7b7d82.c4ac105a.js +++ b/assets/js/0f7b7d82.281cf258.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3533],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>f});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,f=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(f,o(o({ref:t},d),{},{components:r})):a.createElement(f,o({ref:t},d))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[s]="string"==typeof e?e:n,o[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.PreformattedBlockProps",title:"Interface: PreformattedBlockProps",sidebar_label:"@headstartwp/core.react.PreformattedBlockProps",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.PreformattedBlockProps",id:"interfaces/headstartwp_core.react.PreformattedBlockProps",title:"Interface: PreformattedBlockProps",description:"@headstartwp/core.react.PreformattedBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.PreformattedBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.PreformattedBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.PreformattedBlockProps",title:"Interface: PreformattedBlockProps",sidebar_label:"@headstartwp/core.react.PreformattedBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ParagraphBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},next:{title:"@headstartwp/core.react.PullQuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".PreformattedBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PreformattedBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3533],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,o(o({ref:t},d),{},{components:r})):a.createElement(h,o({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[s]="string"==typeof e?e:n,o[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.PreformattedBlockProps",title:"Interface: PreformattedBlockProps",sidebar_label:"@headstartwp/core.react.PreformattedBlockProps",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.PreformattedBlockProps",id:"interfaces/headstartwp_core.react.PreformattedBlockProps",title:"Interface: PreformattedBlockProps",description:"@headstartwp/core.react.PreformattedBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.PreformattedBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.PreformattedBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.PreformattedBlockProps",title:"Interface: PreformattedBlockProps",sidebar_label:"@headstartwp/core.react.PreformattedBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ParagraphBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},next:{title:"@headstartwp/core.react.PullQuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".PreformattedBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PreformattedBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/10176796.390f4775.js b/assets/js/10176796.2aca3f03.js similarity index 94% rename from assets/js/10176796.390f4775.js rename to assets/js/10176796.2aca3f03.js index f93faed1c..eeb27493e 100644 --- a/assets/js/10176796.390f4775.js +++ b/assets/js/10176796.2aca3f03.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4470],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>u});var a=r(7294);function p(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function n(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(p[r]=e[r]);return p}(e,t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(p[r]=e[r])}return p}var l=a.createContext({}),o=function(e){var t=a.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=o(e.components);return a.createElement(l.Provider,{value:t},e.children)},d="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var r=e.components,p=e.mdxType,n=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=o(r),h=p,u=d["".concat(l,".").concat(h)]||d[h]||m[h]||n;return r?a.createElement(u,i(i({ref:t},c),{},{components:r})):a.createElement(u,i({ref:t},c))}));function u(e,t){var r=arguments,p=t&&t.mdxType;if("string"==typeof e||p){var n=r.length,i=new Array(n);i[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[d]="string"==typeof e?e:p,i[1]=s;for(var o=2;o{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>n,metadata:()=>s,toc:()=>o});var a=r(7462),p=(r(7294),r(3905));const n={id:"headstartwp_core.react.StylesElementsPropertiesComplete",title:"Interface: StylesElementsPropertiesComplete",sidebar_label:"@headstartwp/core.react.StylesElementsPropertiesComplete",custom_edit_url:null},i=void 0,s={unversionedId:"interfaces/headstartwp_core.react.StylesElementsPropertiesComplete",id:"interfaces/headstartwp_core.react.StylesElementsPropertiesComplete",title:"Interface: StylesElementsPropertiesComplete",description:"@headstartwp/core.react.StylesElementsPropertiesComplete",source:"@site/docs/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.StylesElementsPropertiesComplete",title:"Interface: StylesElementsPropertiesComplete",sidebar_label:"@headstartwp/core.react.StylesElementsPropertiesComplete",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.SpacerBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},next:{title:"@headstartwp/core.react.StylesProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"}},l={},o=[{value:"Properties",id:"properties",level:2},{value:"h1",id:"h1",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"h2",id:"h2",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"h3",id:"h3",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"h4",id:"h4",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"h5",id:"h5",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"h6",id:"h6",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"link",id:"link",level:3},{value:"Defined in",id:"defined-in-6",level:4}],c={toc:o};function d(e){let{components:t,...r}=e;return(0,p.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".StylesElementsPropertiesComplete"),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"h1"},"h1"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h1"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L682"},"packages/core/src/react/provider/types.ts:682")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"h2"},"h2"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h2"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L683"},"packages/core/src/react/provider/types.ts:683")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"h3"},"h3"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h3"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L684"},"packages/core/src/react/provider/types.ts:684")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"h4"},"h4"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h4"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L685"},"packages/core/src/react/provider/types.ts:685")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"h5"},"h5"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h5"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L686"},"packages/core/src/react/provider/types.ts:686")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"h6"},"h6"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h6"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L687"},"packages/core/src/react/provider/types.ts:687")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"link"},"link"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"link"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L681"},"packages/core/src/react/provider/types.ts:681")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4470],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>u});var a=r(7294);function p(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function n(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(p[r]=e[r]);return p}(e,t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(p[r]=e[r])}return p}var l=a.createContext({}),o=function(e){var t=a.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=o(e.components);return a.createElement(l.Provider,{value:t},e.children)},d="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var r=e.components,p=e.mdxType,n=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=o(r),h=p,u=d["".concat(l,".").concat(h)]||d[h]||m[h]||n;return r?a.createElement(u,i(i({ref:t},c),{},{components:r})):a.createElement(u,i({ref:t},c))}));function u(e,t){var r=arguments,p=t&&t.mdxType;if("string"==typeof e||p){var n=r.length,i=new Array(n);i[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[d]="string"==typeof e?e:p,i[1]=s;for(var o=2;o{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>n,metadata:()=>s,toc:()=>o});var a=r(7462),p=(r(7294),r(3905));const n={id:"headstartwp_core.react.StylesElementsPropertiesComplete",title:"Interface: StylesElementsPropertiesComplete",sidebar_label:"@headstartwp/core.react.StylesElementsPropertiesComplete",custom_edit_url:null},i=void 0,s={unversionedId:"interfaces/headstartwp_core.react.StylesElementsPropertiesComplete",id:"interfaces/headstartwp_core.react.StylesElementsPropertiesComplete",title:"Interface: StylesElementsPropertiesComplete",description:"@headstartwp/core.react.StylesElementsPropertiesComplete",source:"@site/docs/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.StylesElementsPropertiesComplete",title:"Interface: StylesElementsPropertiesComplete",sidebar_label:"@headstartwp/core.react.StylesElementsPropertiesComplete",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.SpacerBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},next:{title:"@headstartwp/core.react.StylesProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"}},l={},o=[{value:"Properties",id:"properties",level:2},{value:"h1",id:"h1",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"h2",id:"h2",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"h3",id:"h3",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"h4",id:"h4",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"h5",id:"h5",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"h6",id:"h6",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"link",id:"link",level:3},{value:"Defined in",id:"defined-in-6",level:4}],c={toc:o};function d(e){let{components:t,...r}=e;return(0,p.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".StylesElementsPropertiesComplete"),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"h1"},"h1"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h1"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L682"},"packages/core/src/react/provider/types.ts:682")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"h2"},"h2"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h2"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L683"},"packages/core/src/react/provider/types.ts:683")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"h3"},"h3"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h3"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L684"},"packages/core/src/react/provider/types.ts:684")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"h4"},"h4"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h4"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L685"},"packages/core/src/react/provider/types.ts:685")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"h5"},"h5"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h5"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L686"},"packages/core/src/react/provider/types.ts:686")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"h6"},"h6"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h6"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L687"},"packages/core/src/react/provider/types.ts:687")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"link"},"link"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"link"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L681"},"packages/core/src/react/provider/types.ts:681")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/126717b4.3aefb7f7.js b/assets/js/126717b4.da4e2884.js similarity index 98% rename from assets/js/126717b4.3aefb7f7.js rename to assets/js/126717b4.da4e2884.js index 039e00353..1cedb49ba 100644 --- a/assets/js/126717b4.3aefb7f7.js +++ b/assets/js/126717b4.da4e2884.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1247],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>N});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),d=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},s=function(e){var t=d(e.components);return n.createElement(p.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},c=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),m=d(a),c=r,N=m["".concat(p,".").concat(c)]||m[c]||k[c]||l;return a?n.createElement(N,i(i({ref:t},s),{},{components:a})):n.createElement(N,i({ref:t},s))}));function N(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,i=new Array(l);i[0]=c;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[m]="string"==typeof e?e:r,i[1]=o;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>m,frontMatter:()=>l,metadata:()=>o,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const l={id:"headstartwp_core.react.SettingsProperties",title:"Interface: SettingsProperties",sidebar_label:"@headstartwp/core.react.SettingsProperties",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.SettingsProperties",id:"interfaces/headstartwp_core.react.SettingsProperties",title:"Interface: SettingsProperties",description:"@headstartwp/core.react.SettingsProperties",source:"@site/docs/interfaces/headstartwp_core.react.SettingsProperties.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.SettingsProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.SettingsProperties",title:"Interface: SettingsProperties",sidebar_label:"@headstartwp/core.react.SettingsProperties",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.SettingsCustomAdditionalProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},next:{title:"@headstartwp/core.react.SpacerBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"}},p={},d=[{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"appearanceTools",id:"appearancetools",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"border",id:"border",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"color",id:"color",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"custom",id:"custom",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"layout",id:"layout",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"spacing",id:"spacing",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"typography",id:"typography",level:3},{value:"Type declaration",id:"type-declaration-4",level:4},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:d};function m(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".SettingsProperties"),(0,r.kt)("h2",{id:"indexable"},"Indexable"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"appearancetools"},"appearanceTools"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"appearanceTools"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Setting that enables ui tools."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L358"},"packages/core/src/react/provider/types.ts:358")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"border"},"border"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"border"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Settings related to borders."),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"color?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom border colors.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"radius?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom border radius.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom border styles.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"width?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom border widths.")))),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L362"},"packages/core/src/react/provider/types.ts:362")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"color"},"color"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"color"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Settings related to colors."),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"background?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set background colors.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"custom?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to select custom colors.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customDuotone?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to create custom duotone filters.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customGradient?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to create custom gradients.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"defaultGradients?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to choose colors from the default gradients.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"defaultPalette?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to choose colors from the default palette.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"duotone?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotone"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotone"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Duotone presets for the duotone picker. Doesn't generate classes or properties.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"gradients?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradient"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradient"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Gradient presets for the gradient picker. Generates a single class (",(0,r.kt)("inlineCode",{parentName:"td"},".has-{slug}-background"),") and custom property (",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--preset--gradient--{slug}"),") per preset value.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"link?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set link colors.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"palette?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpalette"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPalette"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Color palette presets for the color picker. Generates three classes (",(0,r.kt)("inlineCode",{parentName:"td"},".has-{slug}-color"),", ",(0,r.kt)("inlineCode",{parentName:"td"},".has-{slug}-background-color"),", and ",(0,r.kt)("inlineCode",{parentName:"td"},".has-{slug}-border-color"),") and a single custom property (",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--preset--color--{slug}"),") per preset value.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set text colors.")))),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L383"},"packages/core/src/react/provider/types.ts:383")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"custom"},"custom"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"custom"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Generate custom CSS custom properties of the form ",(0,r.kt)("inlineCode",{parentName:"p"},"--wp--custom--{key}--{nested-key}: {value};"),". ",(0,r.kt)("inlineCode",{parentName:"p"},"camelCased")," keys are transformed to ",(0,r.kt)("inlineCode",{parentName:"p"},"kebab-case")," as to follow the CSS property naming schema. Keys at different depth levels are separated by ",(0,r.kt)("inlineCode",{parentName:"p"},"--"),", so keys should not include ",(0,r.kt)("inlineCode",{parentName:"p"},"--")," in the name."),(0,r.kt)("h4",{id:"index-signature"},"Index signature"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsCustomAdditionalProperties"))),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L543"},"packages/core/src/react/provider/types.ts:543")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"layout"},"layout"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"layout"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Settings related to layout."),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contentSize?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the max-width of the content.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"wideSize?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the max-width of wide (",(0,r.kt)("inlineCode",{parentName:"td"},".alignwide"),") content.")))),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L435"},"packages/core/src/react/provider/types.ts:435")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"spacing"},"spacing"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"spacing"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Settings related to spacing."),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockGap?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Enables ",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--style--block-gap")," to be generated from styles.spacing.blockGap. A value of ",(0,r.kt)("inlineCode",{parentName:"td"},"null")," instead of ",(0,r.kt)("inlineCode",{parentName:"td"},"false")," further disables layout styles from being generated.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set a custom margin.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set a custom padding.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"units?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"List of units the user can use for spacing values.")))),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L448"},"packages/core/src/react/provider/types.ts:448")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"typography"},"typography"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"typography"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Settings related to typography."),(0,r.kt)("h4",{id:"type-declaration-4"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customFontSize?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom font sizes.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dropCap?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Enable drop cap.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontFamilies?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"fontFamily?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Font family presets for the font family selector. Generates a single custom property (",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--preset--font-family--{slug}"),") per preset value.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontSizes?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"size?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Font size presets for the font size selector. Generates a single class (",(0,r.kt)("inlineCode",{parentName:"td"},".has-{slug}-color"),") and custom property (",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--preset--font-size--{slug}"),") per preset value.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontStyle?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom font styles.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontWeight?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom font weights.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"letterSpacing?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom letter spacing.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"lineHeight?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom line height.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"textDecoration?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom text decorations.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"textTransform?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom text transforms.")))),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L470"},"packages/core/src/react/provider/types.ts:470")))}m.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1247],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>N});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),d=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},s=function(e){var t=d(e.components);return n.createElement(p.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},c=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),m=d(a),c=r,N=m["".concat(p,".").concat(c)]||m[c]||k[c]||l;return a?n.createElement(N,i(i({ref:t},s),{},{components:a})):n.createElement(N,i({ref:t},s))}));function N(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,i=new Array(l);i[0]=c;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[m]="string"==typeof e?e:r,i[1]=o;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>m,frontMatter:()=>l,metadata:()=>o,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const l={id:"headstartwp_core.react.SettingsProperties",title:"Interface: SettingsProperties",sidebar_label:"@headstartwp/core.react.SettingsProperties",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.SettingsProperties",id:"interfaces/headstartwp_core.react.SettingsProperties",title:"Interface: SettingsProperties",description:"@headstartwp/core.react.SettingsProperties",source:"@site/docs/interfaces/headstartwp_core.react.SettingsProperties.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.SettingsProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.SettingsProperties",title:"Interface: SettingsProperties",sidebar_label:"@headstartwp/core.react.SettingsProperties",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.SettingsCustomAdditionalProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},next:{title:"@headstartwp/core.react.SpacerBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"}},p={},d=[{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"appearanceTools",id:"appearancetools",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"border",id:"border",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"color",id:"color",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"custom",id:"custom",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"layout",id:"layout",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"spacing",id:"spacing",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"typography",id:"typography",level:3},{value:"Type declaration",id:"type-declaration-4",level:4},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:d};function m(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".SettingsProperties"),(0,r.kt)("h2",{id:"indexable"},"Indexable"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"appearancetools"},"appearanceTools"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"appearanceTools"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Setting that enables ui tools."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L358"},"packages/core/src/react/provider/types.ts:358")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"border"},"border"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"border"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Settings related to borders."),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"color?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom border colors.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"radius?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom border radius.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom border styles.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"width?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom border widths.")))),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L362"},"packages/core/src/react/provider/types.ts:362")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"color"},"color"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"color"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Settings related to colors."),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"background?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set background colors.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"custom?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to select custom colors.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customDuotone?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to create custom duotone filters.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customGradient?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to create custom gradients.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"defaultGradients?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to choose colors from the default gradients.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"defaultPalette?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to choose colors from the default palette.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"duotone?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotone"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotone"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Duotone presets for the duotone picker. Doesn't generate classes or properties.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"gradients?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradient"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradient"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Gradient presets for the gradient picker. Generates a single class (",(0,r.kt)("inlineCode",{parentName:"td"},".has-{slug}-background"),") and custom property (",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--preset--gradient--{slug}"),") per preset value.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"link?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set link colors.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"palette?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpalette"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPalette"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Color palette presets for the color picker. Generates three classes (",(0,r.kt)("inlineCode",{parentName:"td"},".has-{slug}-color"),", ",(0,r.kt)("inlineCode",{parentName:"td"},".has-{slug}-background-color"),", and ",(0,r.kt)("inlineCode",{parentName:"td"},".has-{slug}-border-color"),") and a single custom property (",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--preset--color--{slug}"),") per preset value.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set text colors.")))),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L383"},"packages/core/src/react/provider/types.ts:383")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"custom"},"custom"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"custom"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Generate custom CSS custom properties of the form ",(0,r.kt)("inlineCode",{parentName:"p"},"--wp--custom--{key}--{nested-key}: {value};"),". ",(0,r.kt)("inlineCode",{parentName:"p"},"camelCased")," keys are transformed to ",(0,r.kt)("inlineCode",{parentName:"p"},"kebab-case")," as to follow the CSS property naming schema. Keys at different depth levels are separated by ",(0,r.kt)("inlineCode",{parentName:"p"},"--"),", so keys should not include ",(0,r.kt)("inlineCode",{parentName:"p"},"--")," in the name."),(0,r.kt)("h4",{id:"index-signature"},"Index signature"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsCustomAdditionalProperties"))),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L543"},"packages/core/src/react/provider/types.ts:543")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"layout"},"layout"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"layout"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Settings related to layout."),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contentSize?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the max-width of the content.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"wideSize?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the max-width of wide (",(0,r.kt)("inlineCode",{parentName:"td"},".alignwide"),") content.")))),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L435"},"packages/core/src/react/provider/types.ts:435")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"spacing"},"spacing"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"spacing"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Settings related to spacing."),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockGap?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Enables ",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--style--block-gap")," to be generated from styles.spacing.blockGap. A value of ",(0,r.kt)("inlineCode",{parentName:"td"},"null")," instead of ",(0,r.kt)("inlineCode",{parentName:"td"},"false")," further disables layout styles from being generated.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set a custom margin.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set a custom padding.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"units?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"List of units the user can use for spacing values.")))),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L448"},"packages/core/src/react/provider/types.ts:448")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"typography"},"typography"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"typography"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Settings related to typography."),(0,r.kt)("h4",{id:"type-declaration-4"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customFontSize?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom font sizes.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dropCap?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Enable drop cap.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontFamilies?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"fontFamily?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Font family presets for the font family selector. Generates a single custom property (",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--preset--font-family--{slug}"),") per preset value.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontSizes?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"size?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Font size presets for the font size selector. Generates a single class (",(0,r.kt)("inlineCode",{parentName:"td"},".has-{slug}-color"),") and custom property (",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--preset--font-size--{slug}"),") per preset value.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontStyle?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom font styles.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontWeight?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom font weights.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"letterSpacing?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom letter spacing.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"lineHeight?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom line height.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"textDecoration?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom text decorations.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"textTransform?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom text transforms.")))),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L470"},"packages/core/src/react/provider/types.ts:470")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/15509991.021d9b0f.js b/assets/js/15509991.f47a1013.js similarity index 99% rename from assets/js/15509991.021d9b0f.js rename to assets/js/15509991.f47a1013.js index d2bc4439d..b0dbf66c0 100644 --- a/assets/js/15509991.021d9b0f.js +++ b/assets/js/15509991.f47a1013.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1425],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var o=n(7294);function s(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function r(e){for(var t=1;t=0||(s[n]=e[n]);return s}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(s[n]=e[n])}return s}var l=o.createContext({}),p=function(e){var t=o.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},d=function(e){var t=p(e.components);return o.createElement(l.Provider,{value:t},e.children)},u="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},h=o.forwardRef((function(e,t){var n=e.components,s=e.mdxType,a=e.originalType,l=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),u=p(n),h=s,m=u["".concat(l,".").concat(h)]||u[h]||c[h]||a;return n?o.createElement(m,r(r({ref:t},d),{},{components:n})):o.createElement(m,r({ref:t},d))}));function m(e,t){var n=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var a=n.length,r=new Array(a);r[0]=h;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[u]="string"==typeof e?e:s,r[1]=i;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>u,frontMatter:()=>a,metadata:()=>i,toc:()=>p});var o=n(7462),s=(n(7294),n(3905));const a={slug:"/getting-started/headless-config",sidebar_position:3},r="Configuring the Framework",i={unversionedId:"Getting Started/headless-config",id:"Getting Started/headless-config",title:"Configuring the Framework",description:"The headstartwp.config.js (previously, headless.config.js) file contains several config options for HeadstartWP. This file should export an object of type HeadlessConfig.",source:"@site/documentation/01-Getting Started/headless-config.md",sourceDirName:"01-Getting Started",slug:"/getting-started/headless-config",permalink:"/docs/learn/getting-started/headless-config",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/01-Getting Started/headless-config.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:3,frontMatter:{slug:"/getting-started/headless-config",sidebar_position:3},sidebar:"tutorialSidebar",previous:{title:"Setting up the framework from scratch",permalink:"/docs/learn/getting-started/setting-up-manually"},next:{title:"Installing WordPress Plugin",permalink:"/docs/learn/getting-started/installing-wordpress-plugin"}},l={},p=[{value:"Usage with Next.js",id:"usage-with-nextjs",level:2},{value:"sourceUrl",id:"sourceurl",level:2},{value:"useWordPressPlugin",id:"usewordpressplugin",level:2},{value:"hostUrl",id:"hosturl",level:2},{value:"host",id:"host",level:2},{value:"customPostTypes",id:"customposttypes",level:2},{value:"customTaxonomies",id:"customtaxonomies",level:2},{value:"restParam",id:"restparam",level:3},{value:"rewrite",id:"rewrite",level:3},{value:"redirectStrategy",id:"redirectstrategy",level:2},{value:"debug",id:"debug",level:2}],d={toc:p};function u(e){let{components:t,...n}=e;return(0,s.kt)("wrapper",(0,o.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("h1",{id:"configuring-the-framework"},"Configuring the Framework"),(0,s.kt)("p",null,"The ",(0,s.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," (previously, ",(0,s.kt)("inlineCode",{parentName:"p"},"headless.config.js"),") file contains several config options for HeadstartWP. This file should export an object of type ",(0,s.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_core/#headlessconfig"},"HeadlessConfig"),"."),(0,s.kt)("h2",{id:"usage-with-nextjs"},"Usage with Next.js"),(0,s.kt)("p",null,"The file ",(0,s.kt)("strong",{parentName:"p"},"must be named")," either ",(0,s.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," or ",(0,s.kt)("inlineCode",{parentName:"p"},"headless.config.js"),". When ",(0,s.kt)("inlineCode",{parentName:"p"},"injectConfig")," param of ",(0,s.kt)("inlineCode",{parentName:"p"},"withHeadstartWPConfig")," (previously ",(0,s.kt)("inlineCode",{parentName:"p"},"withHeadlessConfig"),") is set to true, the framework will look for these two files to be injected and loaded in the runtime bundle of the Next.js App."),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=next.config.js",title:"next.config.js"},"const { withHeadstartWPConfig } = require('@headstartwp/next/config');\n\n/**\n * Update whatever you need within the nextConfig object.\n *\n * @type {import('next').NextConfig}\n */\nconst nextConfig = {};\n\nmodule.exports = withHeadstartWPConfig(nextConfig);\n")),(0,s.kt)("admonition",{type:"caution"},(0,s.kt)("p",{parentName:"admonition"},"Since ",(0,s.kt)("inlineCode",{parentName:"p"},"@headstartwp/next@1.2.0")," you do not need to import ",(0,s.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," in ",(0,s.kt)("inlineCode",{parentName:"p"},"next.config.js")," anymore, the framework will dynamically load the config.")),(0,s.kt)("p",null,"Here's a sample config file"),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-javascript",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n hostUrl: process.env.HOST_URL,\n customPostTypes: [],\n customTaxonomies: [],\n redirectStrategy: '404',\n useWordPressPlugin: true,\n debug: {\n redirects: false,\n requests: false,\n }\n};\n")),(0,s.kt)("h2",{id:"sourceurl"},"sourceUrl"),(0,s.kt)("p",null,"The ",(0,s.kt)("inlineCode",{parentName:"p"},"sourceUrl")," option should point to a valid WordPress installation from where the headless site should be sourced to."),(0,s.kt)("h2",{id:"usewordpressplugin"},"useWordPressPlugin"),(0,s.kt)("p",null,"The ",(0,s.kt)("inlineCode",{parentName:"p"},"useWordPressPlugin")," indicates whether the WordPress instance at ",(0,s.kt)("inlineCode",{parentName:"p"},"sourceUrl")," contains the Headless WordPress plugin. While it is possible to use this framework without the plugin, it is strongly recommended to install the WP plugin and set this option to true."),(0,s.kt)("h2",{id:"hosturl"},"hostUrl"),(0,s.kt)("p",null,"The ",(0,s.kt)("inlineCode",{parentName:"p"},"hostUrl")," option should contain the value where the frontend app lives. This would typically be the public domain of the site."),(0,s.kt)("h2",{id:"host"},"host"),(0,s.kt)("p",null,"The ",(0,s.kt)("inlineCode",{parentName:"p"},"host")," option is automatically inferred if ",(0,s.kt)("inlineCode",{parentName:"p"},"hostUrl")," is set. You probably don't need to set this option by yourself. The ",(0,s.kt)("inlineCode",{parentName:"p"},"host")," value is used by the multisite feature to match the current site to a site config."),(0,s.kt)("h2",{id:"customposttypes"},"customPostTypes"),(0,s.kt)("p",null,"To add support for custom post types, add your custom post type to the ",(0,s.kt)("inlineCode",{parentName:"p"},"customPostTypes")," setting in ",(0,s.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js"),"."),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n hostUrl: process.env.HOST_URL,\n customPostTypes: [\n {\n slug: 'book',\n endpoint: '/wp-json/wp/v2/book',\n // these should match your file-system routing\n single: '/book',\n archive: '/books',\n },\n ],\n}\n")),(0,s.kt)("p",null,"After adding a custom post type to the config, you will be able to fetch posts from the registered post type via the slug:"),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js"},"usePost({ postType: ['book'] });\nusePosts({ postType:'book', perPage: 10 });\n")),(0,s.kt)("p",null,"The ",(0,s.kt)("inlineCode",{parentName:"p"},"single")," option is required for several things including:"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},'properly previewing custom post types when the "single" route is at a different prefix. E.g: ',(0,s.kt)("inlineCode",{parentName:"li"},"/book/da-vince-code")," instead of ",(0,s.kt)("inlineCode",{parentName:"li"},"/da-vice-code"),"; In this case, the framework will use the ",(0,s.kt)("inlineCode",{parentName:"li"},"single")," path to redirect the previewed post to the right path/route."),(0,s.kt)("li",{parentName:"ul"},"Matching post path permalinks with the current URL. E.g: when fetching a single custom post type the framework will filter the returned posts to the one that matches the existing URL. Therefore, the framework needs to know the single prefix url for custom post types. This is required to properly handle parent pages that share the same child slug. See ",(0,s.kt)("a",{parentName:"li",href:"/learn/data-fetching/usepost/#post-path-matching"},"post path mapping")," for more info.")),(0,s.kt)("p",null,"It is also possible to pass a function, when doing so the default post types (post and pages) will be passed to the function. The code snipped below will disable ",(0,s.kt)("a",{parentName:"p",href:"/learn/data-fetching/usepost/#post-path-matching"},"post path mapping")," to the default post types."),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n hostUrl: process.env.HOST_URL,\n customPostTypes: (defaultPostTypes) => {\n // disable post path mapping for default post types\n return defaultPostTypes.map((postType) => ({...postType, matchSinglePath: false}));\n }\n}\n")),(0,s.kt)("h2",{id:"customtaxonomies"},"customTaxonomies"),(0,s.kt)("p",null,"To add support for custom taxonomies, add your custom taxonomy to the ",(0,s.kt)("inlineCode",{parentName:"p"},"customTaxonomies")," setting in ",(0,s.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js"),"."),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n customPostTypes: [\n {\n slug: 'book',\n endpoint: '/wp-json/wp/v2/book',\n // these should match your file-system routing\n single: '/book',\n archive: '/books',\n },\n ],\n customTaxonomies: [\n { \n slug: 'genre',\n endpoint: '/wp-json/wp/v2/genre',\n postType: ['book'],\n rewrite: 'genre',\n restParam: 'genre'\n },\n ],\n}\n")),(0,s.kt)("p",null,"After adding a custom taxonomy to the config, you will be able to filter posts by the registered taxonomy or fetch terms from it."),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js"},"usePost({ postType: ['book'], genre: 'action' });\nusePosts({ postType:'book', genre: 'action', perPage: 10 });\nuseTerms({ taxonomy: 'genre' });\n")),(0,s.kt)("p",null,"Additionally, if you have an archive route such as ",(0,s.kt)("inlineCode",{parentName:"p"},"/blog")," or ",(0,s.kt)("inlineCode",{parentName:"p"},"/books")," filtering for all registered taxonomies works out of the box. For instance, take the headless config above the following page route:"),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/books/[[...path]].js",title:"src/pages/books/[[...path]].js"},"import { usePosts } from '@headstartwp/next';\nconst BooksPage = () => {\n const { data, error, loading } = usePosts({postType: 'book'});\n\n if (error) {\n return 'error';\n }\n\n if (loading) {\n return 'Loading...';\n }\n\n return (\n
    \n {data.posts.map((post) => (\n
  • {post.title.rendered}
  • \n ))}\n
\n );\n};\n\nexport default BooksPage;\n")),(0,s.kt)("p",null,"This route would automatically handle the following URLs:"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},"/books -> list latest books"),(0,s.kt)("li",{parentName:"ul"},"/books/page/x -> paginate books"),(0,s.kt)("li",{parentName:"ul"},"/books/genre/genre-name -> filter books by genre"),(0,s.kt)("li",{parentName:"ul"},"/books/genre/genre-name/page/2 -> paginate books filtered by genre")),(0,s.kt)("admonition",{type:"caution"},(0,s.kt)("p",{parentName:"admonition"},"The code snippet above does not implement pre-fetching, which you probably want to. Check out the ",(0,s.kt)("a",{parentName:"p",href:"/learn/data-fetching/prefetching"},"pre-fetching docs")," for instructions.")),(0,s.kt)("p",null,"It is also possible to specify a function for 'customTaxonomies', when doing so the default taxonomies will be passed to the function. This can be used for instance to enable ",(0,s.kt)("a",{parentName:"p",href:"/learn/data-fetching/useposts#archive-path-matching"},"archive path matching"),"."),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n customPostTypes: [\n {\n slug: 'book',\n endpoint: '/wp-json/wp/v2/book',\n // these should match your file-system routing\n single: '/book',\n archive: '/books',\n },\n ],\n customTaxonomies: (defaultTaxonomies) => {\n return defaultTaxonomies.map((taxonomy) => ({ ...taxonomy, matchArchivePath: true })),\n },\n}\n")),(0,s.kt)("h3",{id:"restparam"},"restParam"),(0,s.kt)("p",null,"This option shouldn't be necessary most of the time, but this is used to map a custom taxonomy to its REST API parameter. Most of the times the slug is equal to the restParam but in some cases it differs. For instance, the default post tag taxonomy has a slug of ",(0,s.kt)("inlineCode",{parentName:"p"},"post_tag")," but a ",(0,s.kt)("inlineCode",{parentName:"p"},"restParam")," of ",(0,s.kt)("inlineCode",{parentName:"p"},"tags")," (i.e., to filter posts by ",(0,s.kt)("inlineCode",{parentName:"p"},"tags")," in the REST API, we must use ",(0,s.kt)("inlineCode",{parentName:"p"},"tags="),")."),(0,s.kt)("h3",{id:"rewrite"},"rewrite"),(0,s.kt)("p",null,"This option controls the expected prefix the taxonomy must use in front-end urls. This generally should match ",(0,s.kt)("inlineCode",{parentName:"p"},"rewrite.slug")," of the ",(0,s.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/reference/functions/register_taxonomy/"},"register_taxonomy")," function."),(0,s.kt)("h2",{id:"redirectstrategy"},"redirectStrategy"),(0,s.kt)("p",null,"This option control how redirects are handled. There are 2 supported methods of handling redirects."),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},"404: If a route 404, the framework will check to see if there's a redirect for that page in WP. If so it performs the redirect. This is the recommended option."),(0,s.kt)("li",{parentName:"ul"},"always: When this option is set, the framework will ",(0,s.kt)("strong",{parentName:"li"},"always")," check for redirects before rendering any page. Using this option carefully since it will impact performance.")),(0,s.kt)("h2",{id:"debug"},"debug"),(0,s.kt)("p",null,"You can enable log debugging for both requests and redirects. ",(0,s.kt)("inlineCode",{parentName:"p"},"debug.requests")," will enable logging all API requests made by the framework and ",(0,s.kt)("inlineCode",{parentName:"p"},"debug.redirects")," will log all attempts to detect and fetch a redirect from WordPress."))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1425],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var o=n(7294);function s(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function r(e){for(var t=1;t=0||(s[n]=e[n]);return s}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(s[n]=e[n])}return s}var l=o.createContext({}),p=function(e){var t=o.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},d=function(e){var t=p(e.components);return o.createElement(l.Provider,{value:t},e.children)},u="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},h=o.forwardRef((function(e,t){var n=e.components,s=e.mdxType,a=e.originalType,l=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),u=p(n),h=s,m=u["".concat(l,".").concat(h)]||u[h]||c[h]||a;return n?o.createElement(m,r(r({ref:t},d),{},{components:n})):o.createElement(m,r({ref:t},d))}));function m(e,t){var n=arguments,s=t&&t.mdxType;if("string"==typeof e||s){var a=n.length,r=new Array(a);r[0]=h;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[u]="string"==typeof e?e:s,r[1]=i;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>u,frontMatter:()=>a,metadata:()=>i,toc:()=>p});var o=n(7462),s=(n(7294),n(3905));const a={slug:"/getting-started/headless-config",sidebar_position:3},r="Configuring the Framework",i={unversionedId:"Getting Started/headless-config",id:"Getting Started/headless-config",title:"Configuring the Framework",description:"The headstartwp.config.js (previously, headless.config.js) file contains several config options for HeadstartWP. This file should export an object of type HeadlessConfig.",source:"@site/documentation/01-Getting Started/headless-config.md",sourceDirName:"01-Getting Started",slug:"/getting-started/headless-config",permalink:"/docs/learn/getting-started/headless-config",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/01-Getting Started/headless-config.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:3,frontMatter:{slug:"/getting-started/headless-config",sidebar_position:3},sidebar:"tutorialSidebar",previous:{title:"Setting up the framework from scratch",permalink:"/docs/learn/getting-started/setting-up-manually"},next:{title:"Installing WordPress Plugin",permalink:"/docs/learn/getting-started/installing-wordpress-plugin"}},l={},p=[{value:"Usage with Next.js",id:"usage-with-nextjs",level:2},{value:"sourceUrl",id:"sourceurl",level:2},{value:"useWordPressPlugin",id:"usewordpressplugin",level:2},{value:"hostUrl",id:"hosturl",level:2},{value:"host",id:"host",level:2},{value:"customPostTypes",id:"customposttypes",level:2},{value:"customTaxonomies",id:"customtaxonomies",level:2},{value:"restParam",id:"restparam",level:3},{value:"rewrite",id:"rewrite",level:3},{value:"redirectStrategy",id:"redirectstrategy",level:2},{value:"debug",id:"debug",level:2}],d={toc:p};function u(e){let{components:t,...n}=e;return(0,s.kt)("wrapper",(0,o.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("h1",{id:"configuring-the-framework"},"Configuring the Framework"),(0,s.kt)("p",null,"The ",(0,s.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," (previously, ",(0,s.kt)("inlineCode",{parentName:"p"},"headless.config.js"),") file contains several config options for HeadstartWP. This file should export an object of type ",(0,s.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_core/#headlessconfig"},"HeadlessConfig"),"."),(0,s.kt)("h2",{id:"usage-with-nextjs"},"Usage with Next.js"),(0,s.kt)("p",null,"The file ",(0,s.kt)("strong",{parentName:"p"},"must be named")," either ",(0,s.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," or ",(0,s.kt)("inlineCode",{parentName:"p"},"headless.config.js"),". When ",(0,s.kt)("inlineCode",{parentName:"p"},"injectConfig")," param of ",(0,s.kt)("inlineCode",{parentName:"p"},"withHeadstartWPConfig")," (previously ",(0,s.kt)("inlineCode",{parentName:"p"},"withHeadlessConfig"),") is set to true, the framework will look for these two files to be injected and loaded in the runtime bundle of the Next.js App."),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=next.config.js",title:"next.config.js"},"const { withHeadstartWPConfig } = require('@headstartwp/next/config');\n\n/**\n * Update whatever you need within the nextConfig object.\n *\n * @type {import('next').NextConfig}\n */\nconst nextConfig = {};\n\nmodule.exports = withHeadstartWPConfig(nextConfig);\n")),(0,s.kt)("admonition",{type:"caution"},(0,s.kt)("p",{parentName:"admonition"},"Since ",(0,s.kt)("inlineCode",{parentName:"p"},"@headstartwp/next@1.2.0")," you do not need to import ",(0,s.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," in ",(0,s.kt)("inlineCode",{parentName:"p"},"next.config.js")," anymore, the framework will dynamically load the config.")),(0,s.kt)("p",null,"Here's a sample config file"),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-javascript",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n hostUrl: process.env.HOST_URL,\n customPostTypes: [],\n customTaxonomies: [],\n redirectStrategy: '404',\n useWordPressPlugin: true,\n debug: {\n redirects: false,\n requests: false,\n }\n};\n")),(0,s.kt)("h2",{id:"sourceurl"},"sourceUrl"),(0,s.kt)("p",null,"The ",(0,s.kt)("inlineCode",{parentName:"p"},"sourceUrl")," option should point to a valid WordPress installation from where the headless site should be sourced to."),(0,s.kt)("h2",{id:"usewordpressplugin"},"useWordPressPlugin"),(0,s.kt)("p",null,"The ",(0,s.kt)("inlineCode",{parentName:"p"},"useWordPressPlugin")," indicates whether the WordPress instance at ",(0,s.kt)("inlineCode",{parentName:"p"},"sourceUrl")," contains the Headless WordPress plugin. While it is possible to use this framework without the plugin, it is strongly recommended to install the WP plugin and set this option to true."),(0,s.kt)("h2",{id:"hosturl"},"hostUrl"),(0,s.kt)("p",null,"The ",(0,s.kt)("inlineCode",{parentName:"p"},"hostUrl")," option should contain the value where the frontend app lives. This would typically be the public domain of the site."),(0,s.kt)("h2",{id:"host"},"host"),(0,s.kt)("p",null,"The ",(0,s.kt)("inlineCode",{parentName:"p"},"host")," option is automatically inferred if ",(0,s.kt)("inlineCode",{parentName:"p"},"hostUrl")," is set. You probably don't need to set this option by yourself. The ",(0,s.kt)("inlineCode",{parentName:"p"},"host")," value is used by the multisite feature to match the current site to a site config."),(0,s.kt)("h2",{id:"customposttypes"},"customPostTypes"),(0,s.kt)("p",null,"To add support for custom post types, add your custom post type to the ",(0,s.kt)("inlineCode",{parentName:"p"},"customPostTypes")," setting in ",(0,s.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js"),"."),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n hostUrl: process.env.HOST_URL,\n customPostTypes: [\n {\n slug: 'book',\n endpoint: '/wp-json/wp/v2/book',\n // these should match your file-system routing\n single: '/book',\n archive: '/books',\n },\n ],\n}\n")),(0,s.kt)("p",null,"After adding a custom post type to the config, you will be able to fetch posts from the registered post type via the slug:"),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js"},"usePost({ postType: ['book'] });\nusePosts({ postType:'book', perPage: 10 });\n")),(0,s.kt)("p",null,"The ",(0,s.kt)("inlineCode",{parentName:"p"},"single")," option is required for several things including:"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},'properly previewing custom post types when the "single" route is at a different prefix. E.g: ',(0,s.kt)("inlineCode",{parentName:"li"},"/book/da-vince-code")," instead of ",(0,s.kt)("inlineCode",{parentName:"li"},"/da-vice-code"),"; In this case, the framework will use the ",(0,s.kt)("inlineCode",{parentName:"li"},"single")," path to redirect the previewed post to the right path/route."),(0,s.kt)("li",{parentName:"ul"},"Matching post path permalinks with the current URL. E.g: when fetching a single custom post type the framework will filter the returned posts to the one that matches the existing URL. Therefore, the framework needs to know the single prefix url for custom post types. This is required to properly handle parent pages that share the same child slug. See ",(0,s.kt)("a",{parentName:"li",href:"/learn/data-fetching/usepost/#post-path-matching"},"post path mapping")," for more info.")),(0,s.kt)("p",null,"It is also possible to pass a function, when doing so the default post types (post and pages) will be passed to the function. The code snipped below will disable ",(0,s.kt)("a",{parentName:"p",href:"/learn/data-fetching/usepost/#post-path-matching"},"post path mapping")," to the default post types."),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n hostUrl: process.env.HOST_URL,\n customPostTypes: (defaultPostTypes) => {\n // disable post path mapping for default post types\n return defaultPostTypes.map((postType) => ({...postType, matchSinglePath: false}));\n }\n}\n")),(0,s.kt)("h2",{id:"customtaxonomies"},"customTaxonomies"),(0,s.kt)("p",null,"To add support for custom taxonomies, add your custom taxonomy to the ",(0,s.kt)("inlineCode",{parentName:"p"},"customTaxonomies")," setting in ",(0,s.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js"),"."),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n customPostTypes: [\n {\n slug: 'book',\n endpoint: '/wp-json/wp/v2/book',\n // these should match your file-system routing\n single: '/book',\n archive: '/books',\n },\n ],\n customTaxonomies: [\n { \n slug: 'genre',\n endpoint: '/wp-json/wp/v2/genre',\n postType: ['book'],\n rewrite: 'genre',\n restParam: 'genre'\n },\n ],\n}\n")),(0,s.kt)("p",null,"After adding a custom taxonomy to the config, you will be able to filter posts by the registered taxonomy or fetch terms from it."),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js"},"usePost({ postType: ['book'], genre: 'action' });\nusePosts({ postType:'book', genre: 'action', perPage: 10 });\nuseTerms({ taxonomy: 'genre' });\n")),(0,s.kt)("p",null,"Additionally, if you have an archive route such as ",(0,s.kt)("inlineCode",{parentName:"p"},"/blog")," or ",(0,s.kt)("inlineCode",{parentName:"p"},"/books")," filtering for all registered taxonomies works out of the box. For instance, take the headless config above the following page route:"),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/books/[[...path]].js",title:"src/pages/books/[[...path]].js"},"import { usePosts } from '@headstartwp/next';\nconst BooksPage = () => {\n const { data, error, loading } = usePosts({postType: 'book'});\n\n if (error) {\n return 'error';\n }\n\n if (loading) {\n return 'Loading...';\n }\n\n return (\n
    \n {data.posts.map((post) => (\n
  • {post.title.rendered}
  • \n ))}\n
\n );\n};\n\nexport default BooksPage;\n")),(0,s.kt)("p",null,"This route would automatically handle the following URLs:"),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},"/books -> list latest books"),(0,s.kt)("li",{parentName:"ul"},"/books/page/x -> paginate books"),(0,s.kt)("li",{parentName:"ul"},"/books/genre/genre-name -> filter books by genre"),(0,s.kt)("li",{parentName:"ul"},"/books/genre/genre-name/page/2 -> paginate books filtered by genre")),(0,s.kt)("admonition",{type:"caution"},(0,s.kt)("p",{parentName:"admonition"},"The code snippet above does not implement pre-fetching, which you probably want to. Check out the ",(0,s.kt)("a",{parentName:"p",href:"/learn/data-fetching/prefetching"},"pre-fetching docs")," for instructions.")),(0,s.kt)("p",null,"It is also possible to specify a function for 'customTaxonomies', when doing so the default taxonomies will be passed to the function. This can be used for instance to enable ",(0,s.kt)("a",{parentName:"p",href:"/learn/data-fetching/useposts#archive-path-matching"},"archive path matching"),"."),(0,s.kt)("pre",null,(0,s.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n customPostTypes: [\n {\n slug: 'book',\n endpoint: '/wp-json/wp/v2/book',\n // these should match your file-system routing\n single: '/book',\n archive: '/books',\n },\n ],\n customTaxonomies: (defaultTaxonomies) => {\n return defaultTaxonomies.map((taxonomy) => ({ ...taxonomy, matchArchivePath: true })),\n },\n}\n")),(0,s.kt)("h3",{id:"restparam"},"restParam"),(0,s.kt)("p",null,"This option shouldn't be necessary most of the time, but this is used to map a custom taxonomy to its REST API parameter. Most of the times the slug is equal to the restParam but in some cases it differs. For instance, the default post tag taxonomy has a slug of ",(0,s.kt)("inlineCode",{parentName:"p"},"post_tag")," but a ",(0,s.kt)("inlineCode",{parentName:"p"},"restParam")," of ",(0,s.kt)("inlineCode",{parentName:"p"},"tags")," (i.e., to filter posts by ",(0,s.kt)("inlineCode",{parentName:"p"},"tags")," in the REST API, we must use ",(0,s.kt)("inlineCode",{parentName:"p"},"tags="),")."),(0,s.kt)("h3",{id:"rewrite"},"rewrite"),(0,s.kt)("p",null,"This option controls the expected prefix the taxonomy must use in front-end urls. This generally should match ",(0,s.kt)("inlineCode",{parentName:"p"},"rewrite.slug")," of the ",(0,s.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/reference/functions/register_taxonomy/"},"register_taxonomy")," function."),(0,s.kt)("h2",{id:"redirectstrategy"},"redirectStrategy"),(0,s.kt)("p",null,"This option control how redirects are handled. There are 2 supported methods of handling redirects."),(0,s.kt)("ul",null,(0,s.kt)("li",{parentName:"ul"},"404: If a route 404, the framework will check to see if there's a redirect for that page in WP. If so it performs the redirect. This is the recommended option."),(0,s.kt)("li",{parentName:"ul"},"always: When this option is set, the framework will ",(0,s.kt)("strong",{parentName:"li"},"always")," check for redirects before rendering any page. Using this option carefully since it will impact performance.")),(0,s.kt)("h2",{id:"debug"},"debug"),(0,s.kt)("p",null,"You can enable log debugging for both requests and redirects. ",(0,s.kt)("inlineCode",{parentName:"p"},"debug.requests")," will enable logging all API requests made by the framework and ",(0,s.kt)("inlineCode",{parentName:"p"},"debug.redirects")," will log all attempts to detect and fetch a redirect from WordPress."))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/173c930b.17f8eb48.js b/assets/js/173c930b.6f56b54b.js similarity index 99% rename from assets/js/173c930b.17f8eb48.js rename to assets/js/173c930b.6f56b54b.js index c6f605420..b1977029b 100644 --- a/assets/js/173c930b.17f8eb48.js +++ b/assets/js/173c930b.6f56b54b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3446],{3905:(e,t,o)=>{o.d(t,{Zo:()=>u,kt:()=>d});var n=o(7294);function r(e,t,o){return t in e?Object.defineProperty(e,t,{value:o,enumerable:!0,configurable:!0,writable:!0}):e[t]=o,e}function a(e,t){var o=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),o.push.apply(o,n)}return o}function s(e){for(var t=1;t=0||(r[o]=e[o]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,o)&&(r[o]=e[o])}return r}var i=n.createContext({}),c=function(e){var t=n.useContext(i),o=t;return e&&(o="function"==typeof e?e(t):s(s({},t),e)),o},u=function(e){var t=c(e.components);return n.createElement(i.Provider,{value:t},e.children)},l="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var o=e.components,r=e.mdxType,a=e.originalType,i=e.parentName,u=p(e,["components","mdxType","originalType","parentName"]),l=c(o),m=r,d=l["".concat(i,".").concat(m)]||l[m]||h[m]||a;return o?n.createElement(d,s(s({ref:t},u),{},{components:o})):n.createElement(d,s({ref:t},u))}));function d(e,t){var o=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=o.length,s=new Array(a);s[0]=m;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p[l]="string"==typeof e?e:r,s[1]=p;for(var c=2;c{o.r(t),o.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>l,frontMatter:()=>a,metadata:()=>p,toc:()=>c});var n=o(7462),r=(o(7294),o(3905));const a={slug:"/data-fetching/creating-your-own-custom-hooks",sidebar_label:"Creating your own custom hooks"},s="Custom hooks",p={unversionedId:"Data Fetching/custom-hooks",id:"Data Fetching/custom-hooks",title:"Custom hooks",description:"Sometimes it might be useful to wrap the framework data-fetching hooks into your own hooks.",source:"@site/documentation/02 - Data Fetching/custom-hooks.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/creating-your-own-custom-hooks",permalink:"/docs/learn/data-fetching/creating-your-own-custom-hooks",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/custom-hooks.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{slug:"/data-fetching/creating-your-own-custom-hooks",sidebar_label:"Creating your own custom hooks"},sidebar:"tutorialSidebar",previous:{title:"The useSeo hook",permalink:"/docs/learn/data-fetching/useSeo"},next:{title:"Prefetching data on the server",permalink:"/docs/learn/data-fetching/prefetching"}},i={},c=[{value:"Creating a custom hook for a custom post type",id:"creating-a-custom-hook-for-a-custom-post-type",level:2},{value:"Creating your own AppSettings hook",id:"creating-your-own-appsettings-hook",level:2},{value:"Custom Strategies",id:"custom-strategies",level:2}],u={toc:c};function l(e){let{components:t,...o}=e;return(0,r.kt)("wrapper",(0,n.Z)({},u,o,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"custom-hooks"},"Custom hooks"),(0,r.kt)("p",null,"Sometimes it might be useful to wrap the framework data-fetching hooks into your own hooks."),(0,r.kt)("h2",{id:"creating-a-custom-hook-for-a-custom-post-type"},"Creating a custom hook for a custom post type"),(0,r.kt)("p",null,"Let's say you have a custom post type and you want to abstract the parameters needed to get that custom post type. You can create your own hook and pass in the required params."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/hooks/useBook.js",title:"src/hooks/useBook.js"},"import { usePost } from '@headstartwp/next';\n\nconst defaultParams = {\n postType: 'book',\n _embed: true,\n};\n\nexport function useBook(params = {}) {\n return usePost({ ...params, ...defaultParams }, options);\n}\n\nuseBook.fetcher = (sourceUrl?: string) => {\n const fetcher = usePost.fetcher(sourceUrl, defaultParams);\n return fetcher;\n};\n")),(0,r.kt)("p",null,"That way, you don't need to keep passing around the ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultParams")," whenever you want to fetch a single book."),(0,r.kt)("p",null,"By wrapping ",(0,r.kt)("inlineCode",{parentName:"p"},"useBook.fetcher")," we can also pass a set of default params to the default ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," fetcher function. This ensures that when you use ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData")," on the server, the data is fetched using the default parameters."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"// no need to manually pass `{ params: { postType: 'book' } }\nconst bookData = await fetchHookData(useBook.fetcher(), context);\n")),(0,r.kt)("p",null,"This is also useful if you're using TypeScript and your custom post type has additional meta fields."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/hooks/useBook.ts",title:"src/hooks/useBook.ts"},"import { usePost } from '@headstartwp/next';\nimport { PostEntity, PostParams } from '@headstartwp/core';\n\nconst defaultParams: PostParams = {\n postType: 'book',\n _embed: true,\n};\n\ninterface Book extends PostEntity {\n isbn: string;\n}\n\nexport function useBook(params: PostParams | {} = {}) {\n return usePost({ ...params, ...defaultParams }, options);\n}\n\nuseBook.fetcher = (sourceUrl?: string) => {\n const fetcher = usePost.fetcher(sourceUrl, defaultParams);\n return fetcher;\n};\n")),(0,r.kt)("p",null,"Then when using the custom hook ",(0,r.kt)("inlineCode",{parentName:"p"},"isbn")," will show up as a property of the returned post objects."),(0,r.kt)("h2",{id:"creating-your-own-appsettings-hook"},"Creating your own AppSettings hook"),(0,r.kt)("p",null,"If you're using TypeScript and you are extending the framework's app endpoint and including new fields, you can create your own custom hook and specify the additional TypeScript types."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/hooks/useMyAppSettings.ts",title:"src/hooks/useMyAppSettings.ts"},"import { FetchResponse, AppEntity, AppSettingsStrategy } from '@headstartwp/core';\nimport { FetchHookOptions } from '@headstartwp/core/react';\nimport { useAppSettings } from '@headstartwp/next';\n\nexport interface MyAppSettings extends AppEntity {\n my_custom_setting: string;\n}\n\nexport function useMyAppSettings(\n options: FetchHookOptions> = {},\n) {\n return useAppSettings({}, options);\n}\n\nuseMyAppSettings.fetcher = (sourceUrl?: string) =>\n new AppSettingsStrategy(sourceUrl);\n")),(0,r.kt)("h2",{id:"custom-strategies"},"Custom Strategies"),(0,r.kt)("p",null,"Depending on what you're doing you might need to create a completely custom Fetch Strategy. A Fetch strategy must extend ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/headstartwp_core.AbstractFetchStrategy/"},"AbstractFetchStrategy")," and it must contain all of the logic needed to fetch the data."),(0,r.kt)("p",null,"If you feel like to need to create a custom strategy check out the ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/tree/develop/packages/core/src/data/strategies"},"default Fetch Strategies")," as well as the ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/tree/develop/packages/core/src/react/hooks"},"hooks")," that implements them."))}l.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3446],{3905:(e,t,o)=>{o.d(t,{Zo:()=>u,kt:()=>d});var n=o(7294);function r(e,t,o){return t in e?Object.defineProperty(e,t,{value:o,enumerable:!0,configurable:!0,writable:!0}):e[t]=o,e}function a(e,t){var o=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),o.push.apply(o,n)}return o}function s(e){for(var t=1;t=0||(r[o]=e[o]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,o)&&(r[o]=e[o])}return r}var i=n.createContext({}),c=function(e){var t=n.useContext(i),o=t;return e&&(o="function"==typeof e?e(t):s(s({},t),e)),o},u=function(e){var t=c(e.components);return n.createElement(i.Provider,{value:t},e.children)},l="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var o=e.components,r=e.mdxType,a=e.originalType,i=e.parentName,u=p(e,["components","mdxType","originalType","parentName"]),l=c(o),m=r,d=l["".concat(i,".").concat(m)]||l[m]||h[m]||a;return o?n.createElement(d,s(s({ref:t},u),{},{components:o})):n.createElement(d,s({ref:t},u))}));function d(e,t){var o=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=o.length,s=new Array(a);s[0]=m;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p[l]="string"==typeof e?e:r,s[1]=p;for(var c=2;c{o.r(t),o.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>l,frontMatter:()=>a,metadata:()=>p,toc:()=>c});var n=o(7462),r=(o(7294),o(3905));const a={slug:"/data-fetching/creating-your-own-custom-hooks",sidebar_label:"Creating your own custom hooks"},s="Custom hooks",p={unversionedId:"Data Fetching/custom-hooks",id:"Data Fetching/custom-hooks",title:"Custom hooks",description:"Sometimes it might be useful to wrap the framework data-fetching hooks into your own hooks.",source:"@site/documentation/02 - Data Fetching/custom-hooks.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/creating-your-own-custom-hooks",permalink:"/docs/learn/data-fetching/creating-your-own-custom-hooks",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/custom-hooks.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{slug:"/data-fetching/creating-your-own-custom-hooks",sidebar_label:"Creating your own custom hooks"},sidebar:"tutorialSidebar",previous:{title:"The useSeo hook",permalink:"/docs/learn/data-fetching/useSeo"},next:{title:"Prefetching data on the server",permalink:"/docs/learn/data-fetching/prefetching"}},i={},c=[{value:"Creating a custom hook for a custom post type",id:"creating-a-custom-hook-for-a-custom-post-type",level:2},{value:"Creating your own AppSettings hook",id:"creating-your-own-appsettings-hook",level:2},{value:"Custom Strategies",id:"custom-strategies",level:2}],u={toc:c};function l(e){let{components:t,...o}=e;return(0,r.kt)("wrapper",(0,n.Z)({},u,o,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"custom-hooks"},"Custom hooks"),(0,r.kt)("p",null,"Sometimes it might be useful to wrap the framework data-fetching hooks into your own hooks."),(0,r.kt)("h2",{id:"creating-a-custom-hook-for-a-custom-post-type"},"Creating a custom hook for a custom post type"),(0,r.kt)("p",null,"Let's say you have a custom post type and you want to abstract the parameters needed to get that custom post type. You can create your own hook and pass in the required params."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/hooks/useBook.js",title:"src/hooks/useBook.js"},"import { usePost } from '@headstartwp/next';\n\nconst defaultParams = {\n postType: 'book',\n _embed: true,\n};\n\nexport function useBook(params = {}) {\n return usePost({ ...params, ...defaultParams }, options);\n}\n\nuseBook.fetcher = (sourceUrl?: string) => {\n const fetcher = usePost.fetcher(sourceUrl, defaultParams);\n return fetcher;\n};\n")),(0,r.kt)("p",null,"That way, you don't need to keep passing around the ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultParams")," whenever you want to fetch a single book."),(0,r.kt)("p",null,"By wrapping ",(0,r.kt)("inlineCode",{parentName:"p"},"useBook.fetcher")," we can also pass a set of default params to the default ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," fetcher function. This ensures that when you use ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData")," on the server, the data is fetched using the default parameters."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"// no need to manually pass `{ params: { postType: 'book' } }\nconst bookData = await fetchHookData(useBook.fetcher(), context);\n")),(0,r.kt)("p",null,"This is also useful if you're using TypeScript and your custom post type has additional meta fields."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/hooks/useBook.ts",title:"src/hooks/useBook.ts"},"import { usePost } from '@headstartwp/next';\nimport { PostEntity, PostParams } from '@headstartwp/core';\n\nconst defaultParams: PostParams = {\n postType: 'book',\n _embed: true,\n};\n\ninterface Book extends PostEntity {\n isbn: string;\n}\n\nexport function useBook(params: PostParams | {} = {}) {\n return usePost({ ...params, ...defaultParams }, options);\n}\n\nuseBook.fetcher = (sourceUrl?: string) => {\n const fetcher = usePost.fetcher(sourceUrl, defaultParams);\n return fetcher;\n};\n")),(0,r.kt)("p",null,"Then when using the custom hook ",(0,r.kt)("inlineCode",{parentName:"p"},"isbn")," will show up as a property of the returned post objects."),(0,r.kt)("h2",{id:"creating-your-own-appsettings-hook"},"Creating your own AppSettings hook"),(0,r.kt)("p",null,"If you're using TypeScript and you are extending the framework's app endpoint and including new fields, you can create your own custom hook and specify the additional TypeScript types."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/hooks/useMyAppSettings.ts",title:"src/hooks/useMyAppSettings.ts"},"import { FetchResponse, AppEntity, AppSettingsStrategy } from '@headstartwp/core';\nimport { FetchHookOptions } from '@headstartwp/core/react';\nimport { useAppSettings } from '@headstartwp/next';\n\nexport interface MyAppSettings extends AppEntity {\n my_custom_setting: string;\n}\n\nexport function useMyAppSettings(\n options: FetchHookOptions> = {},\n) {\n return useAppSettings({}, options);\n}\n\nuseMyAppSettings.fetcher = (sourceUrl?: string) =>\n new AppSettingsStrategy(sourceUrl);\n")),(0,r.kt)("h2",{id:"custom-strategies"},"Custom Strategies"),(0,r.kt)("p",null,"Depending on what you're doing you might need to create a completely custom Fetch Strategy. A Fetch strategy must extend ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/headstartwp_core.AbstractFetchStrategy/"},"AbstractFetchStrategy")," and it must contain all of the logic needed to fetch the data."),(0,r.kt)("p",null,"If you feel like to need to create a custom strategy check out the ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/tree/develop/packages/core/src/data/strategies"},"default Fetch Strategies")," as well as the ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/tree/develop/packages/core/src/react/hooks"},"hooks")," that implements them."))}l.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1937a900.c397d72c.js b/assets/js/1937a900.c06c3bea.js similarity index 90% rename from assets/js/1937a900.c397d72c.js rename to assets/js/1937a900.c06c3bea.js index 4c67ee928..c2dc3805a 100644 --- a/assets/js/1937a900.c397d72c.js +++ b/assets/js/1937a900.c06c3bea.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3138],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),d=c(r),m=n,h=d["".concat(p,".").concat(m)]||d[m]||k[m]||i;return r?a.createElement(h,l(l({ref:t},s),{},{components:r})):a.createElement(h,l({ref:t},s))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[d]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.ColumnBlockProps",title:"Interface: ColumnBlockProps",sidebar_label:"@headstartwp/core.react.ColumnBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ColumnBlockProps",id:"interfaces/headstartwp_core.react.ColumnBlockProps",title:"Interface: ColumnBlockProps",description:"@headstartwp/core.react.ColumnBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ColumnBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ColumnBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ColumnBlockProps",title:"Interface: ColumnBlockProps",sidebar_label:"@headstartwp/core.react.ColumnBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.Colors",permalink:"/docs/api/interfaces/headstartwp_core.react.Colors"},next:{title:"@headstartwp/core.react.ColumnsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ColumnBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ColumnBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3138],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,l(l({ref:t},d),{},{components:r})):a.createElement(h,l({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.ColumnBlockProps",title:"Interface: ColumnBlockProps",sidebar_label:"@headstartwp/core.react.ColumnBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ColumnBlockProps",id:"interfaces/headstartwp_core.react.ColumnBlockProps",title:"Interface: ColumnBlockProps",description:"@headstartwp/core.react.ColumnBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ColumnBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ColumnBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ColumnBlockProps",title:"Interface: ColumnBlockProps",sidebar_label:"@headstartwp/core.react.ColumnBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.Colors",permalink:"/docs/api/interfaces/headstartwp_core.react.Colors"},next:{title:"@headstartwp/core.react.ColumnsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ColumnBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ColumnBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/19a8a98a.3a7590a5.js b/assets/js/19a8a98a.4970140a.js similarity index 91% rename from assets/js/19a8a98a.3a7590a5.js rename to assets/js/19a8a98a.4970140a.js index 98548d8e1..2ff7e2385 100644 --- a/assets/js/19a8a98a.3a7590a5.js +++ b/assets/js/19a8a98a.4970140a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4401],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),d=c(r),m=n,h=d["".concat(p,".").concat(m)]||d[m]||k[m]||i;return r?a.createElement(h,l(l({ref:t},s),{},{components:r})):a.createElement(h,l({ref:t},s))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[d]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.ListBlockProps",title:"Interface: ListBlockProps",sidebar_label:"@headstartwp/core.react.ListBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ListBlockProps",id:"interfaces/headstartwp_core.react.ListBlockProps",title:"Interface: ListBlockProps",description:"@headstartwp/core.react.ListBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ListBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ListBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ListBlockProps",title:"Interface: ListBlockProps",sidebar_label:"@headstartwp/core.react.ListBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ImageBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},next:{title:"@headstartwp/core.react.MediaTextBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"ordered",id:"ordered",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ListBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ListBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ordered"},"ordered"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"ordered"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/ListBlock.tsx#L7"},"packages/core/src/react/blocks/ListBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4401],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,l(l({ref:t},d),{},{components:r})):a.createElement(h,l({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.ListBlockProps",title:"Interface: ListBlockProps",sidebar_label:"@headstartwp/core.react.ListBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ListBlockProps",id:"interfaces/headstartwp_core.react.ListBlockProps",title:"Interface: ListBlockProps",description:"@headstartwp/core.react.ListBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ListBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ListBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ListBlockProps",title:"Interface: ListBlockProps",sidebar_label:"@headstartwp/core.react.ListBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ImageBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},next:{title:"@headstartwp/core.react.MediaTextBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"ordered",id:"ordered",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ListBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ListBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ordered"},"ordered"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"ordered"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/ListBlock.tsx#L7"},"packages/core/src/react/blocks/ListBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1a87c9a6.191fdd7f.js b/assets/js/1a87c9a6.d09f2bdc.js similarity index 85% rename from assets/js/1a87c9a6.191fdd7f.js rename to assets/js/1a87c9a6.d09f2bdc.js index 7125740d4..2436e6f1e 100644 --- a/assets/js/1a87c9a6.191fdd7f.js +++ b/assets/js/1a87c9a6.d09f2bdc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2507],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>f});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var s=r.createContext({}),l=function(e){var t=r.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},c=function(e){var t=l(e.components);return r.createElement(s.Provider,{value:t},e.children)},d="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,s=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),d=l(a),u=n,f=d["".concat(s,".").concat(u)]||d[u]||h[u]||i;return a?r.createElement(f,p(p({ref:t},c),{},{components:a})):r.createElement(f,p({ref:t},c))}));function f(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=u;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[d]="string"==typeof e?e:n,p[1]=o;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.SearchEntity",title:"Interface: SearchEntity",sidebar_label:"@headstartwp/core.SearchEntity",custom_edit_url:null},p=void 0,o={unversionedId:"interfaces/headstartwp_core.SearchEntity",id:"interfaces/headstartwp_core.SearchEntity",title:"Interface: SearchEntity",description:"@headstartwp/core.SearchEntity",source:"@site/docs/interfaces/headstartwp_core.SearchEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.SearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.SearchEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.SearchEntity",title:"Interface: SearchEntity",sidebar_label:"@headstartwp/core.SearchEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.RevisionEntity",permalink:"/docs/api/interfaces/headstartwp_core.RevisionEntity"},next:{title:"@headstartwp/core.TaxonomyArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"searchedValue",id:"searchedvalue",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"subtype",id:"subtype",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-4",level:4}],c={toc:l};function d(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".SearchEntity"),(0,n.kt)("p",null,"Interface for entities from the /wp/v2/search endpoint."),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,n.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SearchEntity"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"searchedvalue"},"searchedValue"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"searchedValue"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L634"},"packages/core/src/data/types/entities.ts:634")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"subtype"},"subtype"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"subtype"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Subtype of Search for the object."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L644"},"packages/core/src/data/types/entities.ts:644")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"type"},"type"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"type"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Type of Search for the object."),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L639"},"packages/core/src/data/types/entities.ts:639")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2507],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>f});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var s=r.createContext({}),l=function(e){var t=r.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},d=function(e){var t=l(e.components);return r.createElement(s.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,s=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),c=l(a),u=n,f=c["".concat(s,".").concat(u)]||c[u]||h[u]||i;return a?r.createElement(f,p(p({ref:t},d),{},{components:a})):r.createElement(f,p({ref:t},d))}));function f(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=u;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[c]="string"==typeof e?e:n,p[1]=o;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.SearchEntity",title:"Interface: SearchEntity",sidebar_label:"@headstartwp/core.SearchEntity",custom_edit_url:null},p=void 0,o={unversionedId:"interfaces/headstartwp_core.SearchEntity",id:"interfaces/headstartwp_core.SearchEntity",title:"Interface: SearchEntity",description:"@headstartwp/core.SearchEntity",source:"@site/docs/interfaces/headstartwp_core.SearchEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.SearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.SearchEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.SearchEntity",title:"Interface: SearchEntity",sidebar_label:"@headstartwp/core.SearchEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.RevisionEntity",permalink:"/docs/api/interfaces/headstartwp_core.RevisionEntity"},next:{title:"@headstartwp/core.TaxonomyArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"searchedValue",id:"searchedvalue",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"subtype",id:"subtype",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-4",level:4}],d={toc:l};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".SearchEntity"),(0,n.kt)("p",null,"Interface for entities from the /wp/v2/search endpoint."),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,n.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SearchEntity"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"searchedvalue"},"searchedValue"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"searchedValue"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L634"},"packages/core/src/data/types/entities.ts:634")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"subtype"},"subtype"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"subtype"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Subtype of Search for the object."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L644"},"packages/core/src/data/types/entities.ts:644")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"type"},"type"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"type"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Type of Search for the object."),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L639"},"packages/core/src/data/types/entities.ts:639")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1efe64df.25fef7d0.js b/assets/js/1efe64df.2bd762a6.js similarity index 91% rename from assets/js/1efe64df.25fef7d0.js rename to assets/js/1efe64df.2bd762a6.js index 44abf9961..98a7b08af 100644 --- a/assets/js/1efe64df.25fef7d0.js +++ b/assets/js/1efe64df.2bd762a6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9410],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.ICodeBlock",title:"Interface: ICodeBlock",sidebar_label:"@headstartwp/core.react.ICodeBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.ICodeBlock",id:"interfaces/headstartwp_core.react.ICodeBlock",title:"Interface: ICodeBlock",description:"@headstartwp/core.react.ICodeBlock",source:"@site/docs/interfaces/headstartwp_core.react.ICodeBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ICodeBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ICodeBlock",title:"Interface: ICodeBlock",sidebar_label:"@headstartwp/core.react.ICodeBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IButtonsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock"},next:{title:"@headstartwp/core.react.IColumnBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ICodeBlock"),(0,n.kt)("p",null,"The interface for the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#codeblock"},"CodeBlock")," component."),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CodeBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ICodeBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CodeBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CodeBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9410],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),d=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),s=d(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?r.createElement(h,l(l({ref:t},c),{},{components:a})):r.createElement(h,l({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.ICodeBlock",title:"Interface: ICodeBlock",sidebar_label:"@headstartwp/core.react.ICodeBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.ICodeBlock",id:"interfaces/headstartwp_core.react.ICodeBlock",title:"Interface: ICodeBlock",description:"@headstartwp/core.react.ICodeBlock",source:"@site/docs/interfaces/headstartwp_core.react.ICodeBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ICodeBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ICodeBlock",title:"Interface: ICodeBlock",sidebar_label:"@headstartwp/core.react.ICodeBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IButtonsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock"},next:{title:"@headstartwp/core.react.IColumnBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ICodeBlock"),(0,n.kt)("p",null,"The interface for the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#codeblock"},"CodeBlock")," component."),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CodeBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ICodeBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CodeBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CodeBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1fbe2079.39f245e9.js b/assets/js/1fbe2079.e9c597ef.js similarity index 99% rename from assets/js/1fbe2079.39f245e9.js rename to assets/js/1fbe2079.e9c597ef.js index 5939b30ab..95d135947 100644 --- a/assets/js/1fbe2079.39f245e9.js +++ b/assets/js/1fbe2079.e9c597ef.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2781],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),l=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},d=function(e){var t=l(e.components);return n.createElement(p.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,p=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),c=l(r),h=a,m=c["".concat(p,".").concat(h)]||c[h]||u[h]||i;return r?n.createElement(m,o(o({ref:t},d),{},{components:r})):n.createElement(m,o({ref:t},d))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,o=new Array(i);o[0]=h;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[c]="string"==typeof e?e:a,o[1]=s;for(var l=2;l{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var n=r(7462),a=(r(7294),r(3905));const i={sidebar_position:0,slug:"/wordpress-integration/previews"},o="Previews",s={unversionedId:"WordPress Integration/previews",id:"WordPress Integration/previews",title:"Previews",description:"The preview feature requires the 10up's headless WordPress plugin installed. The preview functionality is built on top of Next.js preview API. It uses a short-lived JWT token generated on the WordPress side that can only be used for previewing, this means it is not necessary to set up a hardcoded secret between WP and Next.js.",source:"@site/documentation/06-WordPress Integration/previews.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/previews",permalink:"/docs/learn/wordpress-integration/previews",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/previews.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:0,frontMatter:{sidebar_position:0,slug:"/wordpress-integration/previews"},sidebar:"tutorialSidebar",previous:{title:"Rendering Blocks in React Native",permalink:"/docs/learn/gutenberg/rendering-blocks-in-react-native"},next:{title:"Multisite",permalink:"/docs/learn/wordpress-integration/multisite"}},p={},l=[{value:"Usage",id:"usage",level:2},{value:"previewHandler options",id:"previewhandler-options",level:3},{value:"preparePreviewData",id:"preparepreviewdata",level:4},{value:"getRedirectPath",id:"getredirectpath",level:4},{value:"onRedirect",id:"onredirect",level:4},{value:"FAQ",id:"faq",level:2}],d={toc:l};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"previews"},"Previews"),(0,a.kt)("p",null,"The preview feature requires the 10up's headless WordPress plugin installed. The preview functionality is built on top of ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/advanced-features/preview-mode"},"Next.js preview API"),". It uses a short-lived JWT token generated on the WordPress side that can only be used for previewing, this means it is not necessary to set up a hardcoded secret between WP and Next.js."),(0,a.kt)("p",null,"For previews to work, make sure the frontend URL is entered in WP settings as per instructions in ",(0,a.kt)("a",{parentName:"p",href:"/learn/getting-started/installing-wordpress-plugin"},"Installing WordPress Plugin"),"."),(0,a.kt)("p",null,"The logic for generating the JWT token and redirecting to the preview endpoint can be seen ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/develop/wp/headless-wp/includes/classes/Preview/preview.php"},"here"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"$token = PreviewToken::generate(\n [\n 'type' => 'preview',\n 'post_type' => $post_type,\n 'post_id' => $post_id,\n ]\n);\n\n$preview_url = sprintf(\n '%sapi/preview?post_id=%d&post_type=%s&is_revision=%s&token=%s',\n trailingslashit( Plugin::get_react_url() ),\n $post_id,\n $post_type,\n $is_revision ? '1' : '0',\n $token\n);\n\nwp_redirect( $preview_url );\ndie();\n")),(0,a.kt)("p",null,"Below is a summary of the preview workflow."),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"First a token of type ",(0,a.kt)("inlineCode",{parentName:"li"},"preview")," is generated"),(0,a.kt)("li",{parentName:"ul"},"The token encodes the post type and post id."),(0,a.kt)("li",{parentName:"ul"},"A preview URL is generated assuming the preview endpoint lives at ",(0,a.kt)("inlineCode",{parentName:"li"},"/api/preview")),(0,a.kt)("li",{parentName:"ul"},"WordPress redirects to the preview endpoint"),(0,a.kt)("li",{parentName:"ul"},"The token is sent alongside the post_type, post_id and a boolean indicating whether the post being previewed is a revision or not. "),(0,a.kt)("li",{parentName:"ul"},"The token is verified against the parameters and the token is used to fetch the post's draft/revision content.")),(0,a.kt)("h2",{id:"usage"},"Usage"),(0,a.kt)("p",null,"The Next.js project ",(0,a.kt)("strong",{parentName:"p"},"must")," expose a ",(0,a.kt)("inlineCode",{parentName:"p"},"api/preview")," endpoint that uses the ",(0,a.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next/#previewhandler"},"previewHandler"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"//src/pages/api/preview.js\nimport { previewHandler } from '@headstartwp/next';\n\n/**\n * The Preview endpoint just needs to proxy the default preview handler\n *\n * @param {*} req Next.js request object\n * @param {*} res Next.js response object\n *\n * @returns\n */\nexport default async function handler(req, res) {\n return previewHandler(req, res);\n}\n")),(0,a.kt)("p",null,"That's all that is needed to enable WordPress preview."),(0,a.kt)("p",null,"While previewing the URL will not reflect the actual URL of the post, but instead, it will contain the post id and a ",(0,a.kt)("inlineCode",{parentName:"p"},"-preview")," suffix."),(0,a.kt)("h3",{id:"previewhandler-options"},(0,a.kt)("inlineCode",{parentName:"h3"},"previewHandler")," options"),(0,a.kt)("h4",{id:"preparepreviewdata"},(0,a.kt)("inlineCode",{parentName:"h4"},"preparePreviewData")),(0,a.kt)("p",null,"This allows you to alter the preview data object before it is stored by Next.js (i.e before calling ",(0,a.kt)("inlineCode",{parentName:"p"},"res.setPreviewData"),"). You can use this if you need to add additional fields to preview data object."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"export default async function handler(req, res) {\n return previewHandler(req, res, {\n preparePreviewData(req, res, post, previewData) {\n return { ...previewData, name: post.name };\n },\n });\n}\n")),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"name")," would now be available in the context object of ",(0,a.kt)("inlineCode",{parentName:"p"},"getServerSideProps")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"getStaticProps")," (",(0,a.kt)("inlineCode",{parentName:"p"},"ctx.previewData"),");"),(0,a.kt)("h4",{id:"getredirectpath"},(0,a.kt)("inlineCode",{parentName:"h4"},"getRedirectPath")),(0,a.kt)("admonition",{type:"info"},(0,a.kt)("p",{parentName:"admonition"},"This option was added in ",(0,a.kt)("inlineCode",{parentName:"p"},"@headstartwp/next@1.1.0"),".")),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"getRedirectPath")," option allows you to customize the redirected URL that should handle the preview request. This can be useful if you have implemented a non-standard URL structure. For instance, if the permalink for your posts are ",(0,a.kt)("inlineCode",{parentName:"p"},"/%category%/%postname%/")," you could create a ",(0,a.kt)("inlineCode",{parentName:"p"},"/src/pages/[category]/[...path.js]")," route to handle single post. However, once you do that the ",(0,a.kt)("inlineCode",{parentName:"p"},"previewHandler")," doesn't know how to redirect to that URL and as such you will have to provide your own redirect handling."),(0,a.kt)("p",null,"The framework will also use this value to restrict the preview cookie to the post being previewed to avoid bypassing ",(0,a.kt)("inlineCode",{parentName:"p"},"getStaticProps")," until the cookie expires or the browser is closed. See the ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/pages/building-your-application/configuring/preview-mode#specify-the-preview-mode-duration"},"Next.js docs")," for more info."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"import { getPostTerms } from '@headstartwp/core';\nimport { previewHandler } from '@headstartwp/next';\n\nexport default async function handler(req, res) {\n return previewHandler(req, res, {\n getRedirectPath(defaultRedirectPath, post) {\n const { type, id, slug } = post;\n\n if (type === 'post') {\n const terms = getPostTerms(post);\n \n if (Array.isArray(terms?.category) && terms.category.length > 0) {\n const [category] = terms.category;\n\n return `/${categorySlug}/${id}/${slug || id}`;\n }\n }\n\n return defaultRedirectPath\n },\n });\n}\n")),(0,a.kt)("h4",{id:"onredirect"},(0,a.kt)("inlineCode",{parentName:"h4"},"onRedirect")),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"Instead of implementing ",(0,a.kt)("inlineCode",{parentName:"p"},"onRedirect")," we recommend implementing ",(0,a.kt)("inlineCode",{parentName:"p"},"getRedirectPath")," instead as that will only enable the preview cookie for\nthe post being previewed.")),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"onRedirect")," gives you full access to the ",(0,a.kt)("inlineCode",{parentName:"p"},"req")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"res")," objects. If you do need implement this function we recommend also implementing ",(0,a.kt)("inlineCode",{parentName:"p"},"getRedirectPath"),"."),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"When handling redirects yourself, make sure to always append ",(0,a.kt)("inlineCode",{parentName:"p"},"-preview=true")," to the end of the redirected URL.")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"import { getPostTerms } from '@headstartwp/core';\nimport { previewHandler } from '@headstartwp/next';\n\nexport default async function handler(req, res) {\n return previewHandler(req, res, {\n onRedirect(req, res, previewData) {\n return res.redirect('/custom-path-preview-true');\n },\n });\n}\n")),(0,a.kt)("h2",{id:"faq"},"FAQ"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"After a while, the preview URL stops working")),(0,a.kt)("p",null,"The JWT token expires after 5 min by default, after this period, open another preview window from WordPress to preview the post. The Next.js preview cookie also last for only 5 minutes."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"I'm unable to preview a custom post type")),(0,a.kt)("p",null,"Make sure you defined the right ",(0,a.kt)("inlineCode",{parentName:"p"},"single")," property when registering the custom post type. See ",(0,a.kt)("a",{parentName:"p",href:"/learn/getting-started/headless-config/#customposttypes"},"headless config docs"),". The ",(0,a.kt)("inlineCode",{parentName:"p"},"single")," property must match the route prefix for the custom post type."))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2781],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),l=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},d=function(e){var t=l(e.components);return n.createElement(p.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,p=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),c=l(r),h=a,m=c["".concat(p,".").concat(h)]||c[h]||u[h]||i;return r?n.createElement(m,o(o({ref:t},d),{},{components:r})):n.createElement(m,o({ref:t},d))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,o=new Array(i);o[0]=h;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[c]="string"==typeof e?e:a,o[1]=s;for(var l=2;l{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var n=r(7462),a=(r(7294),r(3905));const i={sidebar_position:0,slug:"/wordpress-integration/previews"},o="Previews",s={unversionedId:"WordPress Integration/previews",id:"WordPress Integration/previews",title:"Previews",description:"The preview feature requires the 10up's headless WordPress plugin installed. The preview functionality is built on top of Next.js preview API. It uses a short-lived JWT token generated on the WordPress side that can only be used for previewing, this means it is not necessary to set up a hardcoded secret between WP and Next.js.",source:"@site/documentation/06-WordPress Integration/previews.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/previews",permalink:"/docs/learn/wordpress-integration/previews",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/previews.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:0,frontMatter:{sidebar_position:0,slug:"/wordpress-integration/previews"},sidebar:"tutorialSidebar",previous:{title:"Rendering Blocks in React Native",permalink:"/docs/learn/gutenberg/rendering-blocks-in-react-native"},next:{title:"Multisite",permalink:"/docs/learn/wordpress-integration/multisite"}},p={},l=[{value:"Usage",id:"usage",level:2},{value:"previewHandler options",id:"previewhandler-options",level:3},{value:"preparePreviewData",id:"preparepreviewdata",level:4},{value:"getRedirectPath",id:"getredirectpath",level:4},{value:"onRedirect",id:"onredirect",level:4},{value:"FAQ",id:"faq",level:2}],d={toc:l};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"previews"},"Previews"),(0,a.kt)("p",null,"The preview feature requires the 10up's headless WordPress plugin installed. The preview functionality is built on top of ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/advanced-features/preview-mode"},"Next.js preview API"),". It uses a short-lived JWT token generated on the WordPress side that can only be used for previewing, this means it is not necessary to set up a hardcoded secret between WP and Next.js."),(0,a.kt)("p",null,"For previews to work, make sure the frontend URL is entered in WP settings as per instructions in ",(0,a.kt)("a",{parentName:"p",href:"/learn/getting-started/installing-wordpress-plugin"},"Installing WordPress Plugin"),"."),(0,a.kt)("p",null,"The logic for generating the JWT token and redirecting to the preview endpoint can be seen ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/develop/wp/headless-wp/includes/classes/Preview/preview.php"},"here"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"$token = PreviewToken::generate(\n [\n 'type' => 'preview',\n 'post_type' => $post_type,\n 'post_id' => $post_id,\n ]\n);\n\n$preview_url = sprintf(\n '%sapi/preview?post_id=%d&post_type=%s&is_revision=%s&token=%s',\n trailingslashit( Plugin::get_react_url() ),\n $post_id,\n $post_type,\n $is_revision ? '1' : '0',\n $token\n);\n\nwp_redirect( $preview_url );\ndie();\n")),(0,a.kt)("p",null,"Below is a summary of the preview workflow."),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"First a token of type ",(0,a.kt)("inlineCode",{parentName:"li"},"preview")," is generated"),(0,a.kt)("li",{parentName:"ul"},"The token encodes the post type and post id."),(0,a.kt)("li",{parentName:"ul"},"A preview URL is generated assuming the preview endpoint lives at ",(0,a.kt)("inlineCode",{parentName:"li"},"/api/preview")),(0,a.kt)("li",{parentName:"ul"},"WordPress redirects to the preview endpoint"),(0,a.kt)("li",{parentName:"ul"},"The token is sent alongside the post_type, post_id and a boolean indicating whether the post being previewed is a revision or not. "),(0,a.kt)("li",{parentName:"ul"},"The token is verified against the parameters and the token is used to fetch the post's draft/revision content.")),(0,a.kt)("h2",{id:"usage"},"Usage"),(0,a.kt)("p",null,"The Next.js project ",(0,a.kt)("strong",{parentName:"p"},"must")," expose a ",(0,a.kt)("inlineCode",{parentName:"p"},"api/preview")," endpoint that uses the ",(0,a.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next/#previewhandler"},"previewHandler"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"//src/pages/api/preview.js\nimport { previewHandler } from '@headstartwp/next';\n\n/**\n * The Preview endpoint just needs to proxy the default preview handler\n *\n * @param {*} req Next.js request object\n * @param {*} res Next.js response object\n *\n * @returns\n */\nexport default async function handler(req, res) {\n return previewHandler(req, res);\n}\n")),(0,a.kt)("p",null,"That's all that is needed to enable WordPress preview."),(0,a.kt)("p",null,"While previewing the URL will not reflect the actual URL of the post, but instead, it will contain the post id and a ",(0,a.kt)("inlineCode",{parentName:"p"},"-preview")," suffix."),(0,a.kt)("h3",{id:"previewhandler-options"},(0,a.kt)("inlineCode",{parentName:"h3"},"previewHandler")," options"),(0,a.kt)("h4",{id:"preparepreviewdata"},(0,a.kt)("inlineCode",{parentName:"h4"},"preparePreviewData")),(0,a.kt)("p",null,"This allows you to alter the preview data object before it is stored by Next.js (i.e before calling ",(0,a.kt)("inlineCode",{parentName:"p"},"res.setPreviewData"),"). You can use this if you need to add additional fields to preview data object."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"export default async function handler(req, res) {\n return previewHandler(req, res, {\n preparePreviewData(req, res, post, previewData) {\n return { ...previewData, name: post.name };\n },\n });\n}\n")),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"name")," would now be available in the context object of ",(0,a.kt)("inlineCode",{parentName:"p"},"getServerSideProps")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"getStaticProps")," (",(0,a.kt)("inlineCode",{parentName:"p"},"ctx.previewData"),");"),(0,a.kt)("h4",{id:"getredirectpath"},(0,a.kt)("inlineCode",{parentName:"h4"},"getRedirectPath")),(0,a.kt)("admonition",{type:"info"},(0,a.kt)("p",{parentName:"admonition"},"This option was added in ",(0,a.kt)("inlineCode",{parentName:"p"},"@headstartwp/next@1.1.0"),".")),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"getRedirectPath")," option allows you to customize the redirected URL that should handle the preview request. This can be useful if you have implemented a non-standard URL structure. For instance, if the permalink for your posts are ",(0,a.kt)("inlineCode",{parentName:"p"},"/%category%/%postname%/")," you could create a ",(0,a.kt)("inlineCode",{parentName:"p"},"/src/pages/[category]/[...path.js]")," route to handle single post. However, once you do that the ",(0,a.kt)("inlineCode",{parentName:"p"},"previewHandler")," doesn't know how to redirect to that URL and as such you will have to provide your own redirect handling."),(0,a.kt)("p",null,"The framework will also use this value to restrict the preview cookie to the post being previewed to avoid bypassing ",(0,a.kt)("inlineCode",{parentName:"p"},"getStaticProps")," until the cookie expires or the browser is closed. See the ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/pages/building-your-application/configuring/preview-mode#specify-the-preview-mode-duration"},"Next.js docs")," for more info."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"import { getPostTerms } from '@headstartwp/core';\nimport { previewHandler } from '@headstartwp/next';\n\nexport default async function handler(req, res) {\n return previewHandler(req, res, {\n getRedirectPath(defaultRedirectPath, post) {\n const { type, id, slug } = post;\n\n if (type === 'post') {\n const terms = getPostTerms(post);\n \n if (Array.isArray(terms?.category) && terms.category.length > 0) {\n const [category] = terms.category;\n\n return `/${categorySlug}/${id}/${slug || id}`;\n }\n }\n\n return defaultRedirectPath\n },\n });\n}\n")),(0,a.kt)("h4",{id:"onredirect"},(0,a.kt)("inlineCode",{parentName:"h4"},"onRedirect")),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"Instead of implementing ",(0,a.kt)("inlineCode",{parentName:"p"},"onRedirect")," we recommend implementing ",(0,a.kt)("inlineCode",{parentName:"p"},"getRedirectPath")," instead as that will only enable the preview cookie for\nthe post being previewed.")),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"onRedirect")," gives you full access to the ",(0,a.kt)("inlineCode",{parentName:"p"},"req")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"res")," objects. If you do need implement this function we recommend also implementing ",(0,a.kt)("inlineCode",{parentName:"p"},"getRedirectPath"),"."),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"When handling redirects yourself, make sure to always append ",(0,a.kt)("inlineCode",{parentName:"p"},"-preview=true")," to the end of the redirected URL.")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"import { getPostTerms } from '@headstartwp/core';\nimport { previewHandler } from '@headstartwp/next';\n\nexport default async function handler(req, res) {\n return previewHandler(req, res, {\n onRedirect(req, res, previewData) {\n return res.redirect('/custom-path-preview-true');\n },\n });\n}\n")),(0,a.kt)("h2",{id:"faq"},"FAQ"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"After a while, the preview URL stops working")),(0,a.kt)("p",null,"The JWT token expires after 5 min by default, after this period, open another preview window from WordPress to preview the post. The Next.js preview cookie also last for only 5 minutes."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"I'm unable to preview a custom post type")),(0,a.kt)("p",null,"Make sure you defined the right ",(0,a.kt)("inlineCode",{parentName:"p"},"single")," property when registering the custom post type. See ",(0,a.kt)("a",{parentName:"p",href:"/learn/getting-started/headless-config/#customposttypes"},"headless config docs"),". The ",(0,a.kt)("inlineCode",{parentName:"p"},"single")," property must match the route prefix for the custom post type."))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/20c672e4.6af35806.js b/assets/js/20c672e4.a49b169d.js similarity index 97% rename from assets/js/20c672e4.6af35806.js rename to assets/js/20c672e4.a49b169d.js index 79d43f5ed..cd05b5aca 100644 --- a/assets/js/20c672e4.6af35806.js +++ b/assets/js/20c672e4.a49b169d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2201],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function p(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var c=a.createContext({}),s=function(e){var t=a.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},l=function(e){var t=s(e.components);return a.createElement(c.Provider,{value:t},e.children)},d="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,c=e.parentName,l=i(e,["components","mdxType","originalType","parentName"]),d=s(r),u=n,f=d["".concat(c,".").concat(u)]||d[u]||h[u]||o;return r?a.createElement(f,p(p({ref:t},l),{},{components:r})):a.createElement(f,p({ref:t},l))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,p=new Array(o);p[0]=u;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[d]="string"==typeof e?e:n,p[1]=i;for(var s=2;s{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>p,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>s});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.FetchHookOptions",title:"Interface: FetchHookOptions",sidebar_label:"@headstartwp/core.react.FetchHookOptions",custom_edit_url:null},p=void 0,i={unversionedId:"interfaces/headstartwp_core.react.FetchHookOptions",id:"interfaces/headstartwp_core.react.FetchHookOptions",title:"Interface: FetchHookOptions",description:"@headstartwp/core.react.FetchHookOptions",source:"@site/docs/interfaces/headstartwp_core.react.FetchHookOptions.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.FetchHookOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.FetchHookOptions",title:"Interface: FetchHookOptions",sidebar_label:"@headstartwp/core.react.FetchHookOptions",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.CoverBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},next:{title:"@headstartwp/core.react.FileBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"}},c={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"fetchStrategyOptions",id:"fetchstrategyoptions",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"shouldFetch",id:"shouldfetch",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"swr",id:"swr",level:3},{value:"Defined in",id:"defined-in-2",level:4}],l={toc:s};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".FetchHookOptions"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"fetchstrategyoptions"},"fetchStrategyOptions"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"fetchStrategyOptions"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L12"},"packages/core/src/react/hooks/types.ts:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"shouldfetch"},"shouldFetch"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"shouldFetch"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L14"},"packages/core/src/react/hooks/types.ts:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"swr"},"swr"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"swr"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"PublicConfiguration"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"BareFetcher"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">",">"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L13"},"packages/core/src/react/hooks/types.ts:13")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2201],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function p(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var c=a.createContext({}),s=function(e){var t=a.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},l=function(e){var t=s(e.components);return a.createElement(c.Provider,{value:t},e.children)},d="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,c=e.parentName,l=i(e,["components","mdxType","originalType","parentName"]),d=s(r),u=n,f=d["".concat(c,".").concat(u)]||d[u]||h[u]||o;return r?a.createElement(f,p(p({ref:t},l),{},{components:r})):a.createElement(f,p({ref:t},l))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,p=new Array(o);p[0]=u;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[d]="string"==typeof e?e:n,p[1]=i;for(var s=2;s{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>p,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>s});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.FetchHookOptions",title:"Interface: FetchHookOptions",sidebar_label:"@headstartwp/core.react.FetchHookOptions",custom_edit_url:null},p=void 0,i={unversionedId:"interfaces/headstartwp_core.react.FetchHookOptions",id:"interfaces/headstartwp_core.react.FetchHookOptions",title:"Interface: FetchHookOptions",description:"@headstartwp/core.react.FetchHookOptions",source:"@site/docs/interfaces/headstartwp_core.react.FetchHookOptions.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.FetchHookOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.FetchHookOptions",title:"Interface: FetchHookOptions",sidebar_label:"@headstartwp/core.react.FetchHookOptions",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.CoverBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},next:{title:"@headstartwp/core.react.FileBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"}},c={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"fetchStrategyOptions",id:"fetchstrategyoptions",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"shouldFetch",id:"shouldfetch",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"swr",id:"swr",level:3},{value:"Defined in",id:"defined-in-2",level:4}],l={toc:s};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".FetchHookOptions"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"fetchstrategyoptions"},"fetchStrategyOptions"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"fetchStrategyOptions"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L12"},"packages/core/src/react/hooks/types.ts:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"shouldfetch"},"shouldFetch"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"shouldFetch"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L14"},"packages/core/src/react/hooks/types.ts:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"swr"},"swr"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"swr"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"PublicConfiguration"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"BareFetcher"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">",">"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L13"},"packages/core/src/react/hooks/types.ts:13")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/241565db.ee6d477b.js b/assets/js/241565db.04469004.js similarity index 97% rename from assets/js/241565db.ee6d477b.js rename to assets/js/241565db.04469004.js index a7e6ac7ad..9668294bd 100644 --- a/assets/js/241565db.ee6d477b.js +++ b/assets/js/241565db.04469004.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9210],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.ITableBlock",title:"Interface: ITableBlock",sidebar_label:"@headstartwp/core.react.ITableBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ITableBlock",id:"interfaces/headstartwp_core.react.ITableBlock",title:"Interface: ITableBlock",description:"@headstartwp/core.react.ITableBlock",source:"@site/docs/interfaces/headstartwp_core.react.ITableBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ITableBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ITableBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ITableBlock",title:"Interface: ITableBlock",sidebar_label:"@headstartwp/core.react.ITableBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ISpacerBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock"},next:{title:"@headstartwp/core.react.IVerseBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ITableBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"TableBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ITableBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"TableBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"TableBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9210],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.ITableBlock",title:"Interface: ITableBlock",sidebar_label:"@headstartwp/core.react.ITableBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ITableBlock",id:"interfaces/headstartwp_core.react.ITableBlock",title:"Interface: ITableBlock",description:"@headstartwp/core.react.ITableBlock",source:"@site/docs/interfaces/headstartwp_core.react.ITableBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ITableBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ITableBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ITableBlock",title:"Interface: ITableBlock",sidebar_label:"@headstartwp/core.react.ITableBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ISpacerBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock"},next:{title:"@headstartwp/core.react.IVerseBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ITableBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"TableBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ITableBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"TableBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"TableBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/245007dc.47a27898.js b/assets/js/245007dc.3c87dac7.js similarity index 96% rename from assets/js/245007dc.47a27898.js rename to assets/js/245007dc.3c87dac7.js index 4b1b390b2..4a03a36b5 100644 --- a/assets/js/245007dc.47a27898.js +++ b/assets/js/245007dc.3c87dac7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1398],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>m});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),c=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(a),h=n,m=s["".concat(o,".").concat(h)]||s[h]||k[h]||i;return a?r.createElement(m,p(p({ref:t},d),{},{components:a})):r.createElement(m,p({ref:t},d))}));function m(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=h;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l[s]="string"==typeof e?e:n,p[1]=l;for(var c=2;c{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.ParagraphBlockProps",title:"Interface: ParagraphBlockProps",sidebar_label:"@headstartwp/core.react.ParagraphBlockProps",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.react.ParagraphBlockProps",id:"interfaces/headstartwp_core.react.ParagraphBlockProps",title:"Interface: ParagraphBlockProps",description:"@headstartwp/core.react.ParagraphBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ParagraphBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ParagraphBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ParagraphBlockProps",title:"Interface: ParagraphBlockProps",sidebar_label:"@headstartwp/core.react.ParagraphBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.MediaTextBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},next:{title:"@headstartwp/core.react.PreformattedBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"dropCap",id:"dropcap",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ParagraphBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ParagraphBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"dropcap"},"dropCap"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"dropCap"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/ParagraphBlock.tsx#L8"},"packages/core/src/react/blocks/ParagraphBlock.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1398],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>m});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),c=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(a),h=n,m=s["".concat(o,".").concat(h)]||s[h]||k[h]||i;return a?r.createElement(m,p(p({ref:t},d),{},{components:a})):r.createElement(m,p({ref:t},d))}));function m(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=h;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l[s]="string"==typeof e?e:n,p[1]=l;for(var c=2;c{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.ParagraphBlockProps",title:"Interface: ParagraphBlockProps",sidebar_label:"@headstartwp/core.react.ParagraphBlockProps",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.react.ParagraphBlockProps",id:"interfaces/headstartwp_core.react.ParagraphBlockProps",title:"Interface: ParagraphBlockProps",description:"@headstartwp/core.react.ParagraphBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ParagraphBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ParagraphBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ParagraphBlockProps",title:"Interface: ParagraphBlockProps",sidebar_label:"@headstartwp/core.react.ParagraphBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.MediaTextBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},next:{title:"@headstartwp/core.react.PreformattedBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"dropCap",id:"dropcap",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ParagraphBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ParagraphBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"dropcap"},"dropCap"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"dropCap"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/ParagraphBlock.tsx#L8"},"packages/core/src/react/blocks/ParagraphBlock.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/24728c4e.50d6d344.js b/assets/js/24728c4e.21b35f40.js similarity index 96% rename from assets/js/24728c4e.50d6d344.js rename to assets/js/24728c4e.21b35f40.js index 98539ba2e..a5de6682a 100644 --- a/assets/js/24728c4e.50d6d344.js +++ b/assets/js/24728c4e.21b35f40.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1408],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var d=r.createContext({}),s=function(e){var t=r.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=s(e.components);return r.createElement(d.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),c=s(a),h=n,k=c["".concat(d,".").concat(h)]||c[h]||m[h]||i;return a?r.createElement(k,p(p({ref:t},o),{},{components:a})):r.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=h;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l[c]="string"==typeof e?e:n,p[1]=l;for(var s=2;s{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>s});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.AppSettingsStrategy",title:"Class: AppSettingsStrategy",sidebar_label:"@headstartwp/core.AppSettingsStrategy",custom_edit_url:null},p=void 0,l={unversionedId:"classes/headstartwp_core.AppSettingsStrategy",id:"classes/headstartwp_core.AppSettingsStrategy",title:"Class: AppSettingsStrategy",description:"@headstartwp/core.AppSettingsStrategy",source:"@site/docs/classes/headstartwp_core.AppSettingsStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.AppSettingsStrategy",permalink:"/docs/api/classes/headstartwp_core.AppSettingsStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AppSettingsStrategy",title:"Class: AppSettingsStrategy",sidebar_label:"@headstartwp/core.AppSettingsStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AbstractFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},next:{title:"@headstartwp/core.AuthorArchiveFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy"}},d={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-19",level:4}],o={toc:s};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AppSettingsStrategy"),(0,n.kt)("p",null,"The App Settings strategy is used to fetch the app settings endpoints exposed by the\nheadless wp plugin"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"AppSettingsStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new AppSettingsStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L115"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:115")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L105"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:105")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L110"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:110")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Builds the final endpoint URL based on the passed parameters"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to add to the request")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The endpoint URL."),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L206"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:206")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("p",null,"The default fetcher function"),(0,n.kt)("p",null,"The default fetcher function handles authentication headers and errors from the API."),(0,n.kt)("p",null,"A custom strategy can override this function to run additional logic before or after the fetch call"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetcher options")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L261"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:261")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L339"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:339")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L404"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:404")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L227"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:227")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L369"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:369")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AppSettingsStrategy.ts#L15"},"packages/core/src/data/strategies/AppSettingsStrategy.ts:15")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L168"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:168")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AppSettingsStrategy.ts#L20"},"packages/core/src/data/strategies/AppSettingsStrategy.ts:20")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L327"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L191"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:191")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L379"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:379")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L219"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:219")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L150"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:150")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L146"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:146")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1408],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var d=r.createContext({}),s=function(e){var t=r.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=s(e.components);return r.createElement(d.Provider,{value:t},e.children)},m="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),m=s(a),h=n,k=m["".concat(d,".").concat(h)]||m[h]||c[h]||i;return a?r.createElement(k,p(p({ref:t},o),{},{components:a})):r.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=h;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l[m]="string"==typeof e?e:n,p[1]=l;for(var s=2;s{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>m,frontMatter:()=>i,metadata:()=>l,toc:()=>s});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.AppSettingsStrategy",title:"Class: AppSettingsStrategy",sidebar_label:"@headstartwp/core.AppSettingsStrategy",custom_edit_url:null},p=void 0,l={unversionedId:"classes/headstartwp_core.AppSettingsStrategy",id:"classes/headstartwp_core.AppSettingsStrategy",title:"Class: AppSettingsStrategy",description:"@headstartwp/core.AppSettingsStrategy",source:"@site/docs/classes/headstartwp_core.AppSettingsStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.AppSettingsStrategy",permalink:"/docs/api/classes/headstartwp_core.AppSettingsStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AppSettingsStrategy",title:"Class: AppSettingsStrategy",sidebar_label:"@headstartwp/core.AppSettingsStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AbstractFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},next:{title:"@headstartwp/core.AuthorArchiveFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy"}},d={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-19",level:4}],o={toc:s};function m(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AppSettingsStrategy"),(0,n.kt)("p",null,"The App Settings strategy is used to fetch the app settings endpoints exposed by the\nheadless wp plugin"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"AppSettingsStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new AppSettingsStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L115"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:115")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L105"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:105")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L110"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:110")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Builds the final endpoint URL based on the passed parameters"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to add to the request")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The endpoint URL."),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L206"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:206")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("p",null,"The default fetcher function"),(0,n.kt)("p",null,"The default fetcher function handles authentication headers and errors from the API."),(0,n.kt)("p",null,"A custom strategy can override this function to run additional logic before or after the fetch call"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetcher options")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L261"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:261")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L339"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:339")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L404"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:404")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L227"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:227")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L369"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:369")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AppSettingsStrategy.ts#L15"},"packages/core/src/data/strategies/AppSettingsStrategy.ts:15")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L168"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:168")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AppSettingsStrategy.ts#L20"},"packages/core/src/data/strategies/AppSettingsStrategy.ts:20")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L327"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L191"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:191")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L379"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:379")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L219"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:219")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L150"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:150")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L146"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:146")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/2772b305.dd9d1d46.js b/assets/js/2772b305.c7d93689.js similarity index 90% rename from assets/js/2772b305.dd9d1d46.js rename to assets/js/2772b305.c7d93689.js index ea2fb1567..0d8bd0bee 100644 --- a/assets/js/2772b305.dd9d1d46.js +++ b/assets/js/2772b305.c7d93689.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[157],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),c=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},s=function(e){var t=c(e.components);return r.createElement(o.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),d=c(a),m=n,h=d["".concat(o,".").concat(m)]||d[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},s),{},{components:a})):r.createElement(h,l({ref:t},s))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[d]="string"==typeof e?e:n,l[1]=p;for(var c=2;c{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>p,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.ImageBlockProps",title:"Interface: ImageBlockProps",sidebar_label:"@headstartwp/core.react.ImageBlockProps",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.ImageBlockProps",id:"interfaces/headstartwp_core.react.ImageBlockProps",title:"Interface: ImageBlockProps",description:"@headstartwp/core.react.ImageBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ImageBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ImageBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ImageBlockProps",title:"Interface: ImageBlockProps",sidebar_label:"@headstartwp/core.react.ImageBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IYoutubeLiteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock"},next:{title:"@headstartwp/core.react.ListBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"alt",id:"alt",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"height",id:"height",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"linkDestination",id:"linkdestination",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"sizeSlug",id:"sizeslug",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"src",id:"src",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"width",id:"width",level:3},{value:"Defined in",id:"defined-in-12",level:4}],s={toc:c};function d(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ImageBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ImageBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"alt"},"alt"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"alt"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/ImageBlock.tsx#L14"},"packages/core/src/react/blocks/ImageBlock.tsx:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"height"},"height"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"height"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/ImageBlock.tsx#L10"},"packages/core/src/react/blocks/ImageBlock.tsx:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linkdestination"},"linkDestination"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"linkDestination"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/ImageBlock.tsx#L12"},"packages/core/src/react/blocks/ImageBlock.tsx:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"sizeslug"},"sizeSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"sizeSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/ImageBlock.tsx#L11"},"packages/core/src/react/blocks/ImageBlock.tsx:11")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"src"},"src"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"src"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/ImageBlock.tsx#L13"},"packages/core/src/react/blocks/ImageBlock.tsx:13")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"width"},"width"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"width"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/ImageBlock.tsx#L9"},"packages/core/src/react/blocks/ImageBlock.tsx:9")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[157],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),c=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(o,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[s]="string"==typeof e?e:n,l[1]=p;for(var c=2;c{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.ImageBlockProps",title:"Interface: ImageBlockProps",sidebar_label:"@headstartwp/core.react.ImageBlockProps",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.ImageBlockProps",id:"interfaces/headstartwp_core.react.ImageBlockProps",title:"Interface: ImageBlockProps",description:"@headstartwp/core.react.ImageBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ImageBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ImageBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ImageBlockProps",title:"Interface: ImageBlockProps",sidebar_label:"@headstartwp/core.react.ImageBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IYoutubeLiteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock"},next:{title:"@headstartwp/core.react.ListBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"alt",id:"alt",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"height",id:"height",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"linkDestination",id:"linkdestination",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"sizeSlug",id:"sizeslug",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"src",id:"src",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"width",id:"width",level:3},{value:"Defined in",id:"defined-in-12",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ImageBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ImageBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"alt"},"alt"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"alt"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/ImageBlock.tsx#L14"},"packages/core/src/react/blocks/ImageBlock.tsx:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"height"},"height"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"height"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/ImageBlock.tsx#L10"},"packages/core/src/react/blocks/ImageBlock.tsx:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linkdestination"},"linkDestination"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"linkDestination"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/ImageBlock.tsx#L12"},"packages/core/src/react/blocks/ImageBlock.tsx:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"sizeslug"},"sizeSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"sizeSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/ImageBlock.tsx#L11"},"packages/core/src/react/blocks/ImageBlock.tsx:11")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"src"},"src"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"src"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/ImageBlock.tsx#L13"},"packages/core/src/react/blocks/ImageBlock.tsx:13")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"width"},"width"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"width"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/ImageBlock.tsx#L9"},"packages/core/src/react/blocks/ImageBlock.tsx:9")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/2cb93857.bf18b9c7.js b/assets/js/2cb93857.65f1c763.js similarity index 99% rename from assets/js/2cb93857.bf18b9c7.js rename to assets/js/2cb93857.65f1c763.js index 17a4e8b74..9df96a6be 100644 --- a/assets/js/2cb93857.bf18b9c7.js +++ b/assets/js/2cb93857.65f1c763.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5233],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>u});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var o=n.createContext({}),p=function(e){var t=n.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return n.createElement(o.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,o=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),c=p(r),m=a,u=c["".concat(o,".").concat(m)]||c[m]||k[m]||i;return r?n.createElement(u,l(l({ref:t},s),{},{components:r})):n.createElement(u,l({ref:t},s))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=m;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d[c]="string"==typeof e?e:a,l[1]=d;for(var p=2;p{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>d,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const i={id:"headstartwp_core.EndpointError",title:"Class: EndpointError",sidebar_label:"@headstartwp/core.EndpointError",custom_edit_url:null},l=void 0,d={unversionedId:"classes/headstartwp_core.EndpointError",id:"classes/headstartwp_core.EndpointError",title:"Class: EndpointError",description:"@headstartwp/core.EndpointError",source:"@site/docs/classes/headstartwp_core.EndpointError.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.EndpointError",permalink:"/docs/api/classes/headstartwp_core.EndpointError",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.EndpointError",title:"Class: EndpointError",sidebar_label:"@headstartwp/core.EndpointError",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Element",permalink:"/docs/api/classes/headstartwp_core.Element"},next:{title:"@headstartwp/core.FetchError",permalink:"/docs/api/classes/headstartwp_core.FetchError"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"cause",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"stack",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"prepareStackTrace",id:"preparestacktrace",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:p};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".EndpointError"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"Error")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"EndpointError"))))),(0,a.kt)("h2",{id:"constructors"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new EndpointError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"message"),")"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"Error.constructor"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/errors.ts#L25"},"packages/core/src/utils/errors.ts:25")),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"cause"},"cause"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"cause"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"Error.cause"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"message"},"message"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"message"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"Error.message"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1054"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"Error.name"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1053"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stack"},"stack"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"stack"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"Error.stack"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1055"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:127"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"preparestacktrace"},"prepareStackTrace"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"prepareStackTrace"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"CallSite"),"[]) => ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("p",null,"Optional override for formatting stack traces"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"See"))),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces"},"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces")),(0,a.kt)("h5",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"err")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Error"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"stackTraces")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"CallSite"),"[]")))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"Error.prepareStackTrace"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:140"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stacktracelimit"},"stackTraceLimit"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"stackTraceLimit"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"Error.stackTraceLimit"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:142"),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"capturestacktrace"},"captureStackTrace"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"captureStackTrace"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"targetObject"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"constructorOpt?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"Create .stack property on a target object"),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"targetObject")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Object"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"constructorOpt?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Function"))))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,"Error.captureStackTrace"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:133"))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5233],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>u});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var o=n.createContext({}),p=function(e){var t=n.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return n.createElement(o.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,o=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),c=p(r),m=a,u=c["".concat(o,".").concat(m)]||c[m]||k[m]||i;return r?n.createElement(u,l(l({ref:t},s),{},{components:r})):n.createElement(u,l({ref:t},s))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=m;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d[c]="string"==typeof e?e:a,l[1]=d;for(var p=2;p{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>d,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const i={id:"headstartwp_core.EndpointError",title:"Class: EndpointError",sidebar_label:"@headstartwp/core.EndpointError",custom_edit_url:null},l=void 0,d={unversionedId:"classes/headstartwp_core.EndpointError",id:"classes/headstartwp_core.EndpointError",title:"Class: EndpointError",description:"@headstartwp/core.EndpointError",source:"@site/docs/classes/headstartwp_core.EndpointError.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.EndpointError",permalink:"/docs/api/classes/headstartwp_core.EndpointError",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.EndpointError",title:"Class: EndpointError",sidebar_label:"@headstartwp/core.EndpointError",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Element",permalink:"/docs/api/classes/headstartwp_core.Element"},next:{title:"@headstartwp/core.FetchError",permalink:"/docs/api/classes/headstartwp_core.FetchError"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"cause",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"stack",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"prepareStackTrace",id:"preparestacktrace",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:p};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".EndpointError"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"Error")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"EndpointError"))))),(0,a.kt)("h2",{id:"constructors"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new EndpointError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"message"),")"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"Error.constructor"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/errors.ts#L25"},"packages/core/src/utils/errors.ts:25")),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"cause"},"cause"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"cause"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"Error.cause"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"message"},"message"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"message"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"Error.message"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1054"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"Error.name"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1053"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stack"},"stack"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"stack"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"Error.stack"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1055"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:127"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"preparestacktrace"},"prepareStackTrace"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"prepareStackTrace"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"CallSite"),"[]) => ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("p",null,"Optional override for formatting stack traces"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"See"))),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces"},"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces")),(0,a.kt)("h5",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"err")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Error"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"stackTraces")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"CallSite"),"[]")))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"Error.prepareStackTrace"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:140"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stacktracelimit"},"stackTraceLimit"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"stackTraceLimit"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"Error.stackTraceLimit"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:142"),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"capturestacktrace"},"captureStackTrace"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"captureStackTrace"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"targetObject"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"constructorOpt?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"Create .stack property on a target object"),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"targetObject")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Object"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"constructorOpt?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Function"))))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,"Error.captureStackTrace"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:133"))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/2e459592.2c56b68d.js b/assets/js/2e459592.25c0ab11.js similarity index 96% rename from assets/js/2e459592.2c56b68d.js rename to assets/js/2e459592.25c0ab11.js index 2675bc92d..25e15b9f8 100644 --- a/assets/js/2e459592.2c56b68d.js +++ b/assets/js/2e459592.25c0ab11.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3864],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,o(o({ref:t},d),{},{components:r})):a.createElement(h,o({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[s]="string"==typeof e?e:n,o[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.CodeBlockProps",title:"Interface: CodeBlockProps",sidebar_label:"@headstartwp/core.react.CodeBlockProps",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.CodeBlockProps",id:"interfaces/headstartwp_core.react.CodeBlockProps",title:"Interface: CodeBlockProps",description:"@headstartwp/core.react.CodeBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.CodeBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.CodeBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.CodeBlockProps",title:"Interface: CodeBlockProps",sidebar_label:"@headstartwp/core.react.CodeBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ButtonsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},next:{title:"@headstartwp/core.react.Colors",permalink:"/docs/api/interfaces/headstartwp_core.react.Colors"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".CodeBlockProps"),(0,n.kt)("p",null,"The interface for components rendered by ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#codeblock"},"CodeBlock")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"CodeBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3864],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,o(o({ref:t},d),{},{components:r})):a.createElement(h,o({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[s]="string"==typeof e?e:n,o[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.CodeBlockProps",title:"Interface: CodeBlockProps",sidebar_label:"@headstartwp/core.react.CodeBlockProps",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.CodeBlockProps",id:"interfaces/headstartwp_core.react.CodeBlockProps",title:"Interface: CodeBlockProps",description:"@headstartwp/core.react.CodeBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.CodeBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.CodeBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.CodeBlockProps",title:"Interface: CodeBlockProps",sidebar_label:"@headstartwp/core.react.CodeBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ButtonsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},next:{title:"@headstartwp/core.react.Colors",permalink:"/docs/api/interfaces/headstartwp_core.react.Colors"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".CodeBlockProps"),(0,n.kt)("p",null,"The interface for components rendered by ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#codeblock"},"CodeBlock")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"CodeBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/2f6d1272.57402a1d.js b/assets/js/2f6d1272.8e91b8a4.js similarity index 98% rename from assets/js/2f6d1272.57402a1d.js rename to assets/js/2f6d1272.8e91b8a4.js index 2561eea4b..a33dd1242 100644 --- a/assets/js/2f6d1272.57402a1d.js +++ b/assets/js/2f6d1272.8e91b8a4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5835],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>g});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var c=n.createContext({}),p=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},s=function(e){var t=p(e.components);return n.createElement(c.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,c=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),d=p(r),f=a,g=d["".concat(c,".").concat(f)]||d[f]||u[f]||o;return r?n.createElement(g,i(i({ref:t},s),{},{components:r})):n.createElement(g,i({ref:t},s))}));function g(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=f;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l[d]="string"==typeof e?e:a,i[1]=l;for(var p=2;p{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const o={id:"headstartwp_core.PolylangIntegration",title:"Interface: PolylangIntegration",sidebar_label:"@headstartwp/core.PolylangIntegration",custom_edit_url:null},i=void 0,l={unversionedId:"interfaces/headstartwp_core.PolylangIntegration",id:"interfaces/headstartwp_core.PolylangIntegration",title:"Interface: PolylangIntegration",description:"@headstartwp/core.PolylangIntegration",source:"@site/docs/interfaces/headstartwp_core.PolylangIntegration.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PolylangIntegration",permalink:"/docs/api/interfaces/headstartwp_core.PolylangIntegration",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PolylangIntegration",title:"Interface: PolylangIntegration",sidebar_label:"@headstartwp/core.PolylangIntegration",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PageInfo",permalink:"/docs/api/interfaces/headstartwp_core.PageInfo"},next:{title:"@headstartwp/core.PostEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostEntity"}},c={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"enable",id:"enable",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4}],s={toc:p};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PolylangIntegration"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration"},(0,a.kt)("inlineCode",{parentName:"a"},"Integration"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"PolylangIntegration"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"enable"},"enable"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"enable"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration"},"Integration"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration#enable"},"enable")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/types.ts#L46"},"packages/core/src/types.ts:46")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5835],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>g});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var c=n.createContext({}),p=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},s=function(e){var t=p(e.components);return n.createElement(c.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,c=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),d=p(r),f=a,g=d["".concat(c,".").concat(f)]||d[f]||u[f]||o;return r?n.createElement(g,i(i({ref:t},s),{},{components:r})):n.createElement(g,i({ref:t},s))}));function g(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=f;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l[d]="string"==typeof e?e:a,i[1]=l;for(var p=2;p{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const o={id:"headstartwp_core.PolylangIntegration",title:"Interface: PolylangIntegration",sidebar_label:"@headstartwp/core.PolylangIntegration",custom_edit_url:null},i=void 0,l={unversionedId:"interfaces/headstartwp_core.PolylangIntegration",id:"interfaces/headstartwp_core.PolylangIntegration",title:"Interface: PolylangIntegration",description:"@headstartwp/core.PolylangIntegration",source:"@site/docs/interfaces/headstartwp_core.PolylangIntegration.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PolylangIntegration",permalink:"/docs/api/interfaces/headstartwp_core.PolylangIntegration",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PolylangIntegration",title:"Interface: PolylangIntegration",sidebar_label:"@headstartwp/core.PolylangIntegration",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PageInfo",permalink:"/docs/api/interfaces/headstartwp_core.PageInfo"},next:{title:"@headstartwp/core.PostEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostEntity"}},c={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"enable",id:"enable",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4}],s={toc:p};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PolylangIntegration"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration"},(0,a.kt)("inlineCode",{parentName:"a"},"Integration"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"PolylangIntegration"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"enable"},"enable"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"enable"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration"},"Integration"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration#enable"},"enable")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/types.ts#L46"},"packages/core/src/types.ts:46")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/2f847acf.31a798ea.js b/assets/js/2f847acf.2e1d39d0.js similarity index 96% rename from assets/js/2f847acf.31a798ea.js rename to assets/js/2f847acf.2e1d39d0.js index b756c1152..d05f439fe 100644 --- a/assets/js/2f847acf.31a798ea.js +++ b/assets/js/2f847acf.2e1d39d0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3333],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function o(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),c=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},d=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},s="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),k=r,h=s["".concat(p,".").concat(k)]||s[k]||m[k]||l;return a?n.createElement(h,o(o({ref:t},d),{},{components:a})):n.createElement(h,o({ref:t},d))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,o=new Array(l);o[0]=k;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:r,o[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>l,metadata:()=>i,toc:()=>c});var n=a(7462),r=(a(7294),a(3905));const l={id:"headstartwp_core.react.IColumnBlock",title:"Interface: IColumnBlock",sidebar_label:"@headstartwp/core.react.IColumnBlock",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IColumnBlock",id:"interfaces/headstartwp_core.react.IColumnBlock",title:"Interface: IColumnBlock",description:"@headstartwp/core.react.IColumnBlock",source:"@site/docs/interfaces/headstartwp_core.react.IColumnBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IColumnBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IColumnBlock",title:"Interface: IColumnBlock",sidebar_label:"@headstartwp/core.react.IColumnBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ICodeBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock"},next:{title:"@headstartwp/core.react.IColumnsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IColumnBlock"),(0,r.kt)("p",null,"The common interface for a block transform component"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnBlockProps")),">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IColumnBlock"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classname"},"className"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"component"},"component"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"component"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnBlockProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnBlockProps")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3333],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function o(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),c=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},d=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},s="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),k=r,h=s["".concat(p,".").concat(k)]||s[k]||m[k]||l;return a?n.createElement(h,o(o({ref:t},d),{},{components:a})):n.createElement(h,o({ref:t},d))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,o=new Array(l);o[0]=k;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:r,o[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>l,metadata:()=>i,toc:()=>c});var n=a(7462),r=(a(7294),a(3905));const l={id:"headstartwp_core.react.IColumnBlock",title:"Interface: IColumnBlock",sidebar_label:"@headstartwp/core.react.IColumnBlock",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IColumnBlock",id:"interfaces/headstartwp_core.react.IColumnBlock",title:"Interface: IColumnBlock",description:"@headstartwp/core.react.IColumnBlock",source:"@site/docs/interfaces/headstartwp_core.react.IColumnBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IColumnBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IColumnBlock",title:"Interface: IColumnBlock",sidebar_label:"@headstartwp/core.react.IColumnBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ICodeBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock"},next:{title:"@headstartwp/core.react.IColumnsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IColumnBlock"),(0,r.kt)("p",null,"The common interface for a block transform component"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnBlockProps")),">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IColumnBlock"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classname"},"className"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"component"},"component"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"component"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnBlockProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnBlockProps")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/312a1558.d5564eed.js b/assets/js/312a1558.f38c9ca7.js similarity index 95% rename from assets/js/312a1558.d5564eed.js rename to assets/js/312a1558.f38c9ca7.js index aec1b84bc..d9abb53be 100644 --- a/assets/js/312a1558.d5564eed.js +++ b/assets/js/312a1558.f38c9ca7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2376],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function o(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,o(o({ref:t},d),{},{components:a})):r.createElement(h,o({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[s]="string"==typeof e?e:n,o[1]=l;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.IYoutubeLiteBlock",title:"Interface: IYoutubeLiteBlock",sidebar_label:"@headstartwp/core.react.IYoutubeLiteBlock",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.IYoutubeLiteBlock",id:"interfaces/headstartwp_core.react.IYoutubeLiteBlock",title:"Interface: IYoutubeLiteBlock",description:"@headstartwp/core.react.IYoutubeLiteBlock",source:"@site/docs/interfaces/headstartwp_core.react.IYoutubeLiteBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IYoutubeLiteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IYoutubeLiteBlock",title:"Interface: IYoutubeLiteBlock",sidebar_label:"@headstartwp/core.react.IYoutubeLiteBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IVerseBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock"},next:{title:"@headstartwp/core.react.ImageBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IYoutubeLiteBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"YoutubeLiteBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IYoutubeLiteBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"YoutubeLiteBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"YoutubeLiteBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2376],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function o(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,o(o({ref:t},d),{},{components:a})):r.createElement(h,o({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[s]="string"==typeof e?e:n,o[1]=l;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.IYoutubeLiteBlock",title:"Interface: IYoutubeLiteBlock",sidebar_label:"@headstartwp/core.react.IYoutubeLiteBlock",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.IYoutubeLiteBlock",id:"interfaces/headstartwp_core.react.IYoutubeLiteBlock",title:"Interface: IYoutubeLiteBlock",description:"@headstartwp/core.react.IYoutubeLiteBlock",source:"@site/docs/interfaces/headstartwp_core.react.IYoutubeLiteBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IYoutubeLiteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IYoutubeLiteBlock",title:"Interface: IYoutubeLiteBlock",sidebar_label:"@headstartwp/core.react.IYoutubeLiteBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IVerseBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock"},next:{title:"@headstartwp/core.react.ImageBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IYoutubeLiteBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"YoutubeLiteBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IYoutubeLiteBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"YoutubeLiteBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"YoutubeLiteBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/31d83884.8e63c825.js b/assets/js/31d83884.2b83a6fb.js similarity index 88% rename from assets/js/31d83884.8e63c825.js rename to assets/js/31d83884.2b83a6fb.js index 40b391101..7c48c5ee6 100644 --- a/assets/js/31d83884.8e63c825.js +++ b/assets/js/31d83884.2b83a6fb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2960],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var i=a.createContext({}),l=function(e){var t=a.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},c=function(e){var t=l(e.components);return a.createElement(i.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,i=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),d=l(r),k=n,h=d["".concat(i,".").concat(k)]||d[k]||u[k]||o;return r?a.createElement(h,s(s({ref:t},c),{},{components:r})):a.createElement(h,s({ref:t},c))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=k;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p[d]="string"==typeof e?e:n,s[1]=p;for(var l=2;l{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>p,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.usePostResponse",title:"Interface: usePostResponse",sidebar_label:"@headstartwp/core.react.usePostResponse",custom_edit_url:null},s=void 0,p={unversionedId:"interfaces/headstartwp_core.react.usePostResponse",id:"interfaces/headstartwp_core.react.usePostResponse",title:"Interface: usePostResponse",description:"@headstartwp/core.react.usePostResponse",source:"@site/docs/interfaces/headstartwp_core.react.usePostResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.usePostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.usePostResponse",title:"Interface: usePostResponse",sidebar_label:"@headstartwp/core.react.usePostResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.usePostOrPostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"},next:{title:"@headstartwp/core.react.usePostsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"}},i={},l=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:l};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".usePostResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"usePostResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"post")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/useFetchPost.ts#L15"},"packages/core/src/react/hooks/useFetchPost.ts:15")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2960],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var i=a.createContext({}),l=function(e){var t=a.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},d=function(e){var t=l(e.components);return a.createElement(i.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,i=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),c=l(r),k=n,h=c["".concat(i,".").concat(k)]||c[k]||u[k]||o;return r?a.createElement(h,s(s({ref:t},d),{},{components:r})):a.createElement(h,s({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=k;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p[c]="string"==typeof e?e:n,s[1]=p;for(var l=2;l{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>c,frontMatter:()=>o,metadata:()=>p,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.usePostResponse",title:"Interface: usePostResponse",sidebar_label:"@headstartwp/core.react.usePostResponse",custom_edit_url:null},s=void 0,p={unversionedId:"interfaces/headstartwp_core.react.usePostResponse",id:"interfaces/headstartwp_core.react.usePostResponse",title:"Interface: usePostResponse",description:"@headstartwp/core.react.usePostResponse",source:"@site/docs/interfaces/headstartwp_core.react.usePostResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.usePostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.usePostResponse",title:"Interface: usePostResponse",sidebar_label:"@headstartwp/core.react.usePostResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.usePostOrPostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"},next:{title:"@headstartwp/core.react.usePostsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"}},i={},l=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],d={toc:l};function c(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".usePostResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"usePostResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"post")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/useFetchPost.ts#L15"},"packages/core/src/react/hooks/useFetchPost.ts:15")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/35c3fc85.0845227d.js b/assets/js/35c3fc85.97ca32b4.js similarity index 93% rename from assets/js/35c3fc85.0845227d.js rename to assets/js/35c3fc85.97ca32b4.js index 3813247ce..4e89e9a3d 100644 --- a/assets/js/35c3fc85.0845227d.js +++ b/assets/js/35c3fc85.97ca32b4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9673],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>h});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function p(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var s=a.createContext({}),d=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},o=function(e){var t=d(e.components);return a.createElement(s.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),c=d(n),k=r,h=c["".concat(s,".").concat(k)]||c[k]||u[k]||i;return n?a.createElement(h,p(p({ref:t},o),{},{components:n})):a.createElement(h,p({ref:t},o))}));function h(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,p=new Array(i);p[0]=k;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[c]="string"==typeof e?e:r,p[1]=l;for(var d=2;d{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var a=n(7462),r=(n(7294),n(3905));const i={id:"headstartwp_core.TermEntity",title:"Interface: TermEntity",sidebar_label:"@headstartwp/core.TermEntity",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.TermEntity",id:"interfaces/headstartwp_core.TermEntity",title:"Interface: TermEntity",description:"@headstartwp/core.TermEntity",source:"@site/docs/interfaces/headstartwp_core.TermEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.TermEntity",permalink:"/docs/api/interfaces/headstartwp_core.TermEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.TermEntity",title:"Interface: TermEntity",sidebar_label:"@headstartwp/core.TermEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.TaxonomyEntity",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyEntity"},next:{title:"@headstartwp/core.TypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.TypeEntity"}},s={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"count",id:"count",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"link",id:"link",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"parent",id:"parent",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"taxonomy",id:"taxonomy",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-10",level:4}],o={toc:d};function c(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".TermEntity"),(0,r.kt)("p",null,"Interface for entities that belong to a taxonomy."),(0,r.kt)("p",null,"For example:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"entities from the /wp/v2/categories endpoint."),(0,r.kt)("li",{parentName:"ul"},"entities from the /wp/v2/tags endpoint.")),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"TermEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"count"},"count"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"count"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Number of published posts for the term."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L441"},"packages/core/src/data/types/entities.ts:441")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"HTML description of the term."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L446"},"packages/core/src/data/types/entities.ts:446")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"id"},"id"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Unique identifier for the term."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L436"},"packages/core/src/data/types/entities.ts:436")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"link"},"link"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"link"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"URL of the term."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L451"},"packages/core/src/data/types/entities.ts:451")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,r.kt)("p",null,"Meta fields."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L476"},"packages/core/src/data/types/entities.ts:476")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"HTML title for the term."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L456"},"packages/core/src/data/types/entities.ts:456")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parent"},"parent"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"parent"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The parent term ID."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L471"},"packages/core/src/data/types/entities.ts:471")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"An alphanumeric identifier for the term unique to its type."),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L461"},"packages/core/src/data/types/entities.ts:461")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"taxonomy"},"taxonomy"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"taxonomy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Type attribution for the term."),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L466"},"packages/core/src/data/types/entities.ts:466")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L479"},"packages/core/src/data/types/entities.ts:479")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L478"},"packages/core/src/data/types/entities.ts:478")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9673],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>h});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function p(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var s=a.createContext({}),d=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},o=function(e){var t=d(e.components);return a.createElement(s.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),c=d(n),k=r,h=c["".concat(s,".").concat(k)]||c[k]||u[k]||i;return n?a.createElement(h,p(p({ref:t},o),{},{components:n})):a.createElement(h,p({ref:t},o))}));function h(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,p=new Array(i);p[0]=k;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[c]="string"==typeof e?e:r,p[1]=l;for(var d=2;d{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var a=n(7462),r=(n(7294),n(3905));const i={id:"headstartwp_core.TermEntity",title:"Interface: TermEntity",sidebar_label:"@headstartwp/core.TermEntity",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.TermEntity",id:"interfaces/headstartwp_core.TermEntity",title:"Interface: TermEntity",description:"@headstartwp/core.TermEntity",source:"@site/docs/interfaces/headstartwp_core.TermEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.TermEntity",permalink:"/docs/api/interfaces/headstartwp_core.TermEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.TermEntity",title:"Interface: TermEntity",sidebar_label:"@headstartwp/core.TermEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.TaxonomyEntity",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyEntity"},next:{title:"@headstartwp/core.TypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.TypeEntity"}},s={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"count",id:"count",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"link",id:"link",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"parent",id:"parent",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"taxonomy",id:"taxonomy",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-10",level:4}],o={toc:d};function c(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".TermEntity"),(0,r.kt)("p",null,"Interface for entities that belong to a taxonomy."),(0,r.kt)("p",null,"For example:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"entities from the /wp/v2/categories endpoint."),(0,r.kt)("li",{parentName:"ul"},"entities from the /wp/v2/tags endpoint.")),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"TermEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"count"},"count"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"count"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Number of published posts for the term."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L441"},"packages/core/src/data/types/entities.ts:441")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"HTML description of the term."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L446"},"packages/core/src/data/types/entities.ts:446")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"id"},"id"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Unique identifier for the term."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L436"},"packages/core/src/data/types/entities.ts:436")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"link"},"link"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"link"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"URL of the term."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L451"},"packages/core/src/data/types/entities.ts:451")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,r.kt)("p",null,"Meta fields."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L476"},"packages/core/src/data/types/entities.ts:476")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"HTML title for the term."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L456"},"packages/core/src/data/types/entities.ts:456")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parent"},"parent"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"parent"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The parent term ID."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L471"},"packages/core/src/data/types/entities.ts:471")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"An alphanumeric identifier for the term unique to its type."),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L461"},"packages/core/src/data/types/entities.ts:461")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"taxonomy"},"taxonomy"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"taxonomy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Type attribution for the term."),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L466"},"packages/core/src/data/types/entities.ts:466")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L479"},"packages/core/src/data/types/entities.ts:479")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L478"},"packages/core/src/data/types/entities.ts:478")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/37b079cc.22aa4319.js b/assets/js/37b079cc.78ea3a0b.js similarity index 92% rename from assets/js/37b079cc.22aa4319.js rename to assets/js/37b079cc.78ea3a0b.js index fc1b71457..1e08cc2d6 100644 --- a/assets/js/37b079cc.22aa4319.js +++ b/assets/js/37b079cc.78ea3a0b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7307],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function o(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,o(o({ref:t},d),{},{components:a})):r.createElement(h,o({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[s]="string"==typeof e?e:n,o[1]=l;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.IAudioBlock",title:"Interface: IAudioBlock",sidebar_label:"@headstartwp/core.react.IAudioBlock",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.IAudioBlock",id:"interfaces/headstartwp_core.react.IAudioBlock",title:"Interface: IAudioBlock",description:"@headstartwp/core.react.IAudioBlock",source:"@site/docs/interfaces/headstartwp_core.react.IAudioBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IAudioBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IAudioBlock",title:"Interface: IAudioBlock",sidebar_label:"@headstartwp/core.react.IAudioBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.HtmlDecodeProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps"},next:{title:"@headstartwp/core.react.IBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IAudioBlock"),(0,n.kt)("p",null,"The interface for the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#audioblock"},"AudioBlock")," component."),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"AudioBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IAudioBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"AudioBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"AudioBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7307],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function o(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),d=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),s=d(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,o(o({ref:t},c),{},{components:a})):r.createElement(h,o({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[s]="string"==typeof e?e:n,o[1]=l;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.IAudioBlock",title:"Interface: IAudioBlock",sidebar_label:"@headstartwp/core.react.IAudioBlock",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.IAudioBlock",id:"interfaces/headstartwp_core.react.IAudioBlock",title:"Interface: IAudioBlock",description:"@headstartwp/core.react.IAudioBlock",source:"@site/docs/interfaces/headstartwp_core.react.IAudioBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IAudioBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IAudioBlock",title:"Interface: IAudioBlock",sidebar_label:"@headstartwp/core.react.IAudioBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.HtmlDecodeProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps"},next:{title:"@headstartwp/core.react.IBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlock"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IAudioBlock"),(0,n.kt)("p",null,"The interface for the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#audioblock"},"AudioBlock")," component."),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"AudioBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IAudioBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"AudioBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"AudioBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/37d12b40.a26c08aa.js b/assets/js/37d12b40.82ad1805.js similarity index 89% rename from assets/js/37d12b40.a26c08aa.js rename to assets/js/37d12b40.82ad1805.js index 32c450349..4961d490a 100644 --- a/assets/js/37d12b40.a26c08aa.js +++ b/assets/js/37d12b40.82ad1805.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[26],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>u});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var i=a.createContext({}),l=function(e){var t=a.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},c=function(e){var t=l(e.components);return a.createElement(i.Provider,{value:t},e.children)},d="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,i=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),d=l(r),k=n,u=d["".concat(i,".").concat(k)]||d[k]||m[k]||o;return r?a.createElement(u,s(s({ref:t},c),{},{components:r})):a.createElement(u,s({ref:t},c))}));function u(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=k;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p[d]="string"==typeof e?e:n,s[1]=p;for(var l=2;l{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>p,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.useTermsResponse",title:"Interface: useTermsResponse",sidebar_label:"@headstartwp/core.react.useTermsResponse",custom_edit_url:null},s=void 0,p={unversionedId:"interfaces/headstartwp_core.react.useTermsResponse",id:"interfaces/headstartwp_core.react.useTermsResponse",title:"Interface: useTermsResponse",description:"@headstartwp/core.react.useTermsResponse",source:"@site/docs/interfaces/headstartwp_core.react.useTermsResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.useTermsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.useTermsResponse",title:"Interface: useTermsResponse",sidebar_label:"@headstartwp/core.react.useTermsResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.useSearchResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"},next:{title:"@headstartwp/next.FetchHookDataOptions",permalink:"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions"}},i={},l=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:l};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".useTermsResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"useTermsResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"pageInfo")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"terms")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]")))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/useFetchTerms.ts#L15"},"packages/core/src/react/hooks/useFetchTerms.ts:15")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[26],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>u});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var i=a.createContext({}),l=function(e){var t=a.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},d=function(e){var t=l(e.components);return a.createElement(i.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,i=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),c=l(r),k=n,u=c["".concat(i,".").concat(k)]||c[k]||m[k]||o;return r?a.createElement(u,s(s({ref:t},d),{},{components:r})):a.createElement(u,s({ref:t},d))}));function u(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=k;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p[c]="string"==typeof e?e:n,s[1]=p;for(var l=2;l{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>c,frontMatter:()=>o,metadata:()=>p,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.useTermsResponse",title:"Interface: useTermsResponse",sidebar_label:"@headstartwp/core.react.useTermsResponse",custom_edit_url:null},s=void 0,p={unversionedId:"interfaces/headstartwp_core.react.useTermsResponse",id:"interfaces/headstartwp_core.react.useTermsResponse",title:"Interface: useTermsResponse",description:"@headstartwp/core.react.useTermsResponse",source:"@site/docs/interfaces/headstartwp_core.react.useTermsResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.useTermsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.useTermsResponse",title:"Interface: useTermsResponse",sidebar_label:"@headstartwp/core.react.useTermsResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.useSearchResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"},next:{title:"@headstartwp/next.FetchHookDataOptions",permalink:"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions"}},i={},l=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],d={toc:l};function c(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".useTermsResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"useTermsResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"pageInfo")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"terms")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]")))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/useFetchTerms.ts#L15"},"packages/core/src/react/hooks/useFetchTerms.ts:15")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/37ef8e6f.17f02eb3.js b/assets/js/37ef8e6f.b9af90f6.js similarity index 99% rename from assets/js/37ef8e6f.17f02eb3.js rename to assets/js/37ef8e6f.b9af90f6.js index e75b05af9..8efb95226 100644 --- a/assets/js/37ef8e6f.17f02eb3.js +++ b/assets/js/37ef8e6f.b9af90f6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[228],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>h});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var o=a.createContext({}),p=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=p(e.components);return a.createElement(o.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},c=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,o=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),m=p(n),c=i,h=m["".concat(o,".").concat(c)]||m[c]||k[c]||r;return n?a.createElement(h,l(l({ref:t},s),{},{components:n})):a.createElement(h,l({ref:t},s))}));function h(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,l=new Array(r);l[0]=c;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d[m]="string"==typeof e?e:i,l[1]=d;for(var p=2;p{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>m,frontMatter:()=>r,metadata:()=>d,toc:()=>p});var a=n(7462),i=(n(7294),n(3905));const r={id:"headstartwp_next.ImageProps",title:"Interface: ImageProps",sidebar_label:"@headstartwp/next.ImageProps",custom_edit_url:null},l=void 0,d={unversionedId:"interfaces/headstartwp_next.ImageProps",id:"interfaces/headstartwp_next.ImageProps",title:"Interface: ImageProps",description:"@headstartwp/next.ImageProps",source:"@site/docs/interfaces/headstartwp_next.ImageProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_next.ImageProps",permalink:"/docs/api/interfaces/headstartwp_next.ImageProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_next.ImageProps",title:"Interface: ImageProps",sidebar_label:"@headstartwp/next.ImageProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/next.FetchHookDataOptions",permalink:"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions"},next:{title:"@headstartwp/next.LinkBlockProps",permalink:"/docs/api/interfaces/headstartwp_next.LinkBlockProps"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"alt",id:"alt",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"height",id:"height",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"linkDestination",id:"linkdestination",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"loader",id:"loader",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-8",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"sizeSlug",id:"sizeslug",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"src",id:"src",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"width",id:"width",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-13",level:4}],s={toc:p};function m(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next"},"@headstartwp/next"),".ImageProps"),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("inlineCode",{parentName:"p"},"ImageBlockProps")),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"ImageProps"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"alt"},"alt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"alt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.alt"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:9"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"attributes"},"attributes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"attributes"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"align")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Align"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"border")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Border"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"colors")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Colors"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"spacing")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Spacing"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"typography")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Typography"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"width?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.attributes"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:70"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"children"},"children"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"children"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.children"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:69"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"classname"},"className"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"className"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.className"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:65"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"domnode"},"domNode"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"domNode"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Element")),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.domNode"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:67"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"height"},"height"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"height"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.height"),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:5"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.htmlAnchor"),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:68"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"linkdestination"},"linkDestination"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"linkDestination"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.linkDestination"),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:7"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"loader"},"loader"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"loader"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ImageLoaderProps")," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#vipcustomimageloader"},(0,i.kt)("inlineCode",{parentName:"a"},"VIPCustomImageLoader")),") => ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,i.kt)("p",null,"\u25b8 (",(0,i.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h5",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"props")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"ImageLoaderProps")," ","|"," ",(0,i.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#vipcustomimageloader"},(0,i.kt)("inlineCode",{parentName:"a"},"VIPCustomImageLoader")))))),(0,i.kt)("h5",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/components/ImageComponent.tsx#L75"},"packages/next/src/components/ImageComponent.tsx:75")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"name"},"name"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"name"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.name"),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:64"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sizeslug"},"sizeSlug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"sizeSlug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.sizeSlug"),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:6"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"src"},"src"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"src"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.src"),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:8"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"style"},"style"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"style"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.style"),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:66"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"width"},"width"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"width"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.width"),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:4"))}m.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[228],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>h});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var o=a.createContext({}),p=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=p(e.components);return a.createElement(o.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},c=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,o=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),m=p(n),c=i,h=m["".concat(o,".").concat(c)]||m[c]||k[c]||r;return n?a.createElement(h,l(l({ref:t},s),{},{components:n})):a.createElement(h,l({ref:t},s))}));function h(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,l=new Array(r);l[0]=c;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d[m]="string"==typeof e?e:i,l[1]=d;for(var p=2;p{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>m,frontMatter:()=>r,metadata:()=>d,toc:()=>p});var a=n(7462),i=(n(7294),n(3905));const r={id:"headstartwp_next.ImageProps",title:"Interface: ImageProps",sidebar_label:"@headstartwp/next.ImageProps",custom_edit_url:null},l=void 0,d={unversionedId:"interfaces/headstartwp_next.ImageProps",id:"interfaces/headstartwp_next.ImageProps",title:"Interface: ImageProps",description:"@headstartwp/next.ImageProps",source:"@site/docs/interfaces/headstartwp_next.ImageProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_next.ImageProps",permalink:"/docs/api/interfaces/headstartwp_next.ImageProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_next.ImageProps",title:"Interface: ImageProps",sidebar_label:"@headstartwp/next.ImageProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/next.FetchHookDataOptions",permalink:"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions"},next:{title:"@headstartwp/next.LinkBlockProps",permalink:"/docs/api/interfaces/headstartwp_next.LinkBlockProps"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"alt",id:"alt",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"height",id:"height",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"linkDestination",id:"linkdestination",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"loader",id:"loader",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-8",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"sizeSlug",id:"sizeslug",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"src",id:"src",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"width",id:"width",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-13",level:4}],s={toc:p};function m(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next"},"@headstartwp/next"),".ImageProps"),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("inlineCode",{parentName:"p"},"ImageBlockProps")),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"ImageProps"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"alt"},"alt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"alt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.alt"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:9"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"attributes"},"attributes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"attributes"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"align")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Align"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"border")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Border"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"colors")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Colors"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"spacing")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Spacing"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"typography")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Typography"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"width?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.attributes"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:70"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"children"},"children"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"children"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.children"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:69"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"classname"},"className"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"className"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.className"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:65"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"domnode"},"domNode"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"domNode"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Element")),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.domNode"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:67"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"height"},"height"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"height"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.height"),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:5"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.htmlAnchor"),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:68"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"linkdestination"},"linkDestination"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"linkDestination"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.linkDestination"),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:7"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"loader"},"loader"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"loader"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ImageLoaderProps")," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#vipcustomimageloader"},(0,i.kt)("inlineCode",{parentName:"a"},"VIPCustomImageLoader")),") => ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,i.kt)("p",null,"\u25b8 (",(0,i.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h5",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"props")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"ImageLoaderProps")," ","|"," ",(0,i.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#vipcustomimageloader"},(0,i.kt)("inlineCode",{parentName:"a"},"VIPCustomImageLoader")))))),(0,i.kt)("h5",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/components/ImageComponent.tsx#L75"},"packages/next/src/components/ImageComponent.tsx:75")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"name"},"name"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"name"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.name"),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:64"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sizeslug"},"sizeSlug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"sizeSlug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.sizeSlug"),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:6"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"src"},"src"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"src"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.src"),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:8"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"style"},"style"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"style"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.style"),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:66"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"width"},"width"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"width"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.width"),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:4"))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/38f0e7b9.7579e018.js b/assets/js/38f0e7b9.16106ab8.js similarity index 95% rename from assets/js/38f0e7b9.7579e018.js rename to assets/js/38f0e7b9.16106ab8.js index 90bc3d7b7..f85ccabbd 100644 --- a/assets/js/38f0e7b9.7579e018.js +++ b/assets/js/38f0e7b9.16106ab8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2254],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var s=r.createContext({}),d=function(e){var t=r.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},o=function(e){var t=d(e.components);return r.createElement(s.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,s=e.parentName,o=p(e,["components","mdxType","originalType","parentName"]),c=d(a),m=n,h=c["".concat(s,".").concat(m)]||c[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},o),{},{components:a})):r.createElement(h,l({ref:t},o))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[c]="string"==typeof e?e:n,l[1]=p;for(var d=2;d{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>p,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.SinglePostFetchStrategy",title:"Class: SinglePostFetchStrategy",sidebar_label:"@headstartwp/core.SinglePostFetchStrategy",custom_edit_url:null},l=void 0,p={unversionedId:"classes/headstartwp_core.SinglePostFetchStrategy",id:"classes/headstartwp_core.SinglePostFetchStrategy",title:"Class: SinglePostFetchStrategy",description:"@headstartwp/core.SinglePostFetchStrategy",source:"@site/docs/classes/headstartwp_core.SinglePostFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.SinglePostFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.SinglePostFetchStrategy",title:"Class: SinglePostFetchStrategy",sidebar_label:"@headstartwp/core.SinglePostFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.SearchFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SearchFetchStrategy"},next:{title:"@headstartwp/core.TaxonomyTermsStrategy",permalink:"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy"}},s={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"locale",id:"locale",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"path",id:"path",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"postType",id:"posttype",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"revision",id:"revision",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"shouldCheckCurrentPathAgainstPostLink",id:"shouldcheckcurrentpathagainstpostlink",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-5",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"getPostThatMatchesCurrentPath",id:"getpostthatmatchescurrentpath",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Overrides",id:"overrides-6",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-25",level:4}],o={toc:d};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".SinglePostFetchStrategy"),(0,n.kt)("p",null,"The SinglePostFetchStrategy is used to fetch a single post entity from any post type.\nNote that custom post types should be defined in ",(0,n.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,n.kt)("p",null,"This strategy supports extracting endpoint params from url E.g:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/post-name")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ slug: 'post-name'}")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/2021/10/20/post-name")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ year: 2021, month: 10, day: 20, slug: 'post-name }")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/2021/")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ year: 2021, slug: 'post-name' }"))),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"See"))),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy#getparamsfromurl"},"getParamsFromURL")," to learn about url param mapping"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SinglePostFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new SinglePostFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L115"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:115")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L105"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:105")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L110"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:110")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"locale"},"locale"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"locale"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L89"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:89")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"path"},"path"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"path"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L87"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:87")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"posttype"},"postType"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"postType"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"'post'")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L83"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:83")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"revision"},"revision"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"revision"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L85"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:85")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"shouldcheckcurrentpathagainstpostlink"},"shouldCheckCurrentPathAgainstPostLink"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"shouldCheckCurrentPathAgainstPostLink"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"true")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L91"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:91")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Handlers post types, revisions and fetching by id"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint url")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L127"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:127")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("p",null,"Handles fetching by multiple post types, authToken and revisions"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The url to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint url")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"FetchOptions")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L275"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:275")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L338"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:338")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L404"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:404")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L227"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:227")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L369"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:369")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-3"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L93"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:93")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-4"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L97"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:97")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"overrides-5"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L102"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:102")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpostthatmatchescurrentpath"},"getPostThatMatchesCurrentPath"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPostThatMatchesCurrentPath"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"result"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"T")),(0,n.kt)("p",null,"Returns only the post that matches the current path"),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"result")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"T")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L166"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:166")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L327"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L191"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:191")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L379"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:379")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("p",null,"Prepares the post response"),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("h4",{id:"overrides-6"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L205"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L150"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:150")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L146"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:146")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2254],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var s=r.createContext({}),d=function(e){var t=r.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},o=function(e){var t=d(e.components);return r.createElement(s.Provider,{value:t},e.children)},k="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,s=e.parentName,o=p(e,["components","mdxType","originalType","parentName"]),k=d(a),c=n,h=k["".concat(s,".").concat(c)]||k[c]||m[c]||i;return a?r.createElement(h,l(l({ref:t},o),{},{components:a})):r.createElement(h,l({ref:t},o))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=c;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[k]="string"==typeof e?e:n,l[1]=p;for(var d=2;d{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>p,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.SinglePostFetchStrategy",title:"Class: SinglePostFetchStrategy",sidebar_label:"@headstartwp/core.SinglePostFetchStrategy",custom_edit_url:null},l=void 0,p={unversionedId:"classes/headstartwp_core.SinglePostFetchStrategy",id:"classes/headstartwp_core.SinglePostFetchStrategy",title:"Class: SinglePostFetchStrategy",description:"@headstartwp/core.SinglePostFetchStrategy",source:"@site/docs/classes/headstartwp_core.SinglePostFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.SinglePostFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.SinglePostFetchStrategy",title:"Class: SinglePostFetchStrategy",sidebar_label:"@headstartwp/core.SinglePostFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.SearchFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SearchFetchStrategy"},next:{title:"@headstartwp/core.TaxonomyTermsStrategy",permalink:"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy"}},s={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"locale",id:"locale",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"path",id:"path",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"postType",id:"posttype",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"revision",id:"revision",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"shouldCheckCurrentPathAgainstPostLink",id:"shouldcheckcurrentpathagainstpostlink",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-5",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"getPostThatMatchesCurrentPath",id:"getpostthatmatchescurrentpath",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Overrides",id:"overrides-6",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-25",level:4}],o={toc:d};function k(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".SinglePostFetchStrategy"),(0,n.kt)("p",null,"The SinglePostFetchStrategy is used to fetch a single post entity from any post type.\nNote that custom post types should be defined in ",(0,n.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,n.kt)("p",null,"This strategy supports extracting endpoint params from url E.g:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/post-name")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ slug: 'post-name'}")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/2021/10/20/post-name")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ year: 2021, month: 10, day: 20, slug: 'post-name }")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/2021/")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ year: 2021, slug: 'post-name' }"))),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"See"))),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy#getparamsfromurl"},"getParamsFromURL")," to learn about url param mapping"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SinglePostFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new SinglePostFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L115"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:115")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L105"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:105")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L110"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:110")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"locale"},"locale"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"locale"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L89"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:89")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"path"},"path"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"path"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L87"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:87")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"posttype"},"postType"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"postType"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"'post'")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L83"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:83")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"revision"},"revision"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"revision"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L85"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:85")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"shouldcheckcurrentpathagainstpostlink"},"shouldCheckCurrentPathAgainstPostLink"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"shouldCheckCurrentPathAgainstPostLink"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"true")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L91"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:91")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Handlers post types, revisions and fetching by id"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint url")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L127"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:127")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("p",null,"Handles fetching by multiple post types, authToken and revisions"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The url to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint url")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"FetchOptions")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L275"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:275")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L338"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:338")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L404"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:404")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L227"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:227")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L369"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:369")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-3"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L93"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:93")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-4"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L97"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:97")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"overrides-5"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L102"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:102")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpostthatmatchescurrentpath"},"getPostThatMatchesCurrentPath"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPostThatMatchesCurrentPath"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"result"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"T")),(0,n.kt)("p",null,"Returns only the post that matches the current path"),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"result")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"T")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L166"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:166")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L327"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L191"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:191")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L379"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:379")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("p",null,"Prepares the post response"),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("h4",{id:"overrides-6"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L205"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L150"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:150")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L146"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:146")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/3b216a90.9ce89cf7.js b/assets/js/3b216a90.41d44886.js similarity index 99% rename from assets/js/3b216a90.9ce89cf7.js rename to assets/js/3b216a90.41d44886.js index 57820eaac..022b4ca24 100644 --- a/assets/js/3b216a90.9ce89cf7.js +++ b/assets/js/3b216a90.41d44886.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8989],{3905:(e,t,a)=>{a.d(t,{Zo:()=>h,kt:()=>g});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function s(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var l=n.createContext({}),p=function(e){var t=n.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):s(s({},t),e)),a},h=function(e){var t=p(e.components);return n.createElement(l.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},c=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,h=i(e,["components","mdxType","originalType","parentName"]),d=p(a),c=r,g=d["".concat(l,".").concat(c)]||d[c]||u[c]||o;return a?n.createElement(g,s(s({ref:t},h),{},{components:a})):n.createElement(g,s({ref:t},h))}));function g(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=a.length,s=new Array(o);s[0]=c;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[d]="string"==typeof e?e:r,s[1]=i;for(var p=2;p{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var n=a(7462),r=(a(7294),a(3905));const o={slug:"/getting-started/quick-tutorial"},s="Quick Introduction to the Framework",i={unversionedId:"Getting Started/quick-tutorial",id:"Getting Started/quick-tutorial",title:"Quick Introduction to the Framework",description:"Introduction",source:"@site/documentation/01-Getting Started/quick-tutorial.md",sourceDirName:"01-Getting Started",slug:"/getting-started/quick-tutorial",permalink:"/docs/learn/getting-started/quick-tutorial",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/01-Getting Started/quick-tutorial.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{slug:"/getting-started/quick-tutorial"},sidebar:"tutorialSidebar",previous:{title:"Installing WordPress Plugin",permalink:"/docs/learn/getting-started/installing-wordpress-plugin"},next:{title:"Introduction",permalink:"/docs/learn/data-fetching"}},l={},p=[{value:"Introduction",id:"introduction",level:2},{value:"How Routing Works",id:"how-routing-works",level:2},{value:"Basic Data Fetching",id:"basic-data-fetching",level:3},{value:"Main Query, Queried Object, and SEO handling.",id:"main-query-queried-object-and-seo-handling",level:2},{value:"Should you handle loading/error states on the client?",id:"should-you-handle-loadingerror-states-on-the-client",level:2}],h={toc:p};function d(e){let{components:t,...o}=e;return(0,r.kt)("wrapper",(0,n.Z)({},h,o,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"quick-introduction-to-the-framework"},"Quick Introduction to the Framework"),(0,r.kt)("h2",{id:"introduction"},"Introduction"),(0,r.kt)("p",null,"If you\u2019re familiar with Next.js you probably already know that it has a file-system-based router. The routes are declared under the ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages")," folder. To learn more about Next.js routing, read the ",(0,r.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/routing/introduction"},"official docs"),"."),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"the ",(0,r.kt)("inlineCode",{parentName:"p"},"app")," folder is currently not supported by HeadstartWP. Support for new Next.js 13 features, including the app directory, are underway.")),(0,r.kt)("p",null,"HeadstartWP takes advantage of Next.js routing by leveraging a feature called \u201ccatch-all routes\u201d which allows the framework to automatically map URL segments to WordPress routes and the proper REST API parameters necessary to fetch the appropriate data. It does so by adopting a convention of using a \u201ccatch-all\u201d route named ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"[[...path]].js"),"."),(0,r.kt)("h2",{id:"how-routing-works"},"How Routing Works"),(0,r.kt)("p",null,"To understand how routing works in the framework, let\u2019s take a look at the route in the starter project (",(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/develop/projects/wp-nextjs/src/pages/%5B...path%5D.js"},"src/pages/[...path].js"),") that corresponds to a single post/page template (single.php) in WordPress."),(0,r.kt)("p",null,"First, note that it is using single brackets and not double brackets. That is because we only want to \u201ccatch\u201d that route if no other top-level route is matched (such as ",(0,r.kt)("inlineCode",{parentName:"p"},"index.js"),"). Therefore, any route in the form of /post-name or /2022/10/1 will match ",(0,r.kt)("inlineCode",{parentName:"p"},"src/[...path].js"),". You can confirm this by opening any post by either the /post-name route or the date route depending on how your permalinks settings are set up in WordPress E.g:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://headless-framework.vercel.app/2020/05/07/distinctio-rerum-ratione-maxime-repudiandae-laboriosam-quam"},"https://headless-framework.vercel.app/2020/05/07/distinctio-rerum-ratione-maxime-repudiandae-laboriosam-quam")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://headless-framework.vercel.app/distinctio-rerum-ratione-maxime-repudiandae-laboriosam-quam"},"https://headless-framework.vercel.app/distinctio-rerum-ratione-maxime-repudiandae-laboriosam-quam"))),(0,r.kt)("p",null,"The great thing about this is that you don\u2019t need multiple Next.js routes to handle the same resource!"),(0,r.kt)("h3",{id:"basic-data-fetching"},"Basic Data Fetching"),(0,r.kt)("p",null,"Now let\u2019s look at how data fetching for this route works. To make things easier to understand, let\u2019s disregard ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticPaths")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps")," functions."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/params.js"',title:'"src/params.js"'},"/**\n * @type {import('@headstartwp/core').PostParams}\n */\nexport const singleParams = { postType: ['page', 'post'] };\n")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"import { usePost } from '@headstartwp/next';\n\nconst SinglePostsPage = () => {\n const { loading, error } = usePost(singleParams);\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n \n
\n );\n};\n")),(0,r.kt)("p",null,"At this point, the page is not rendered on the server (or at build time) at all. Therefore this route is behaving like a single-page application."),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," hook is one of the framework's data-fetching hooks. As its name suggests it fetches a single post for a given set of params. We\u2019re passing one param called ",(0,r.kt)("inlineCode",{parentName:"p"},"postType"),', which is telling the hook to fetch the current page from either the "page" or "post" post type. Note that we\'re not passing the slug. Passing the slug is optional and if you don\'t pass the slug, the framework will automatically extract the post/page slug from the URL, if present.'),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"Extracting the ",(0,r.kt)("em",{parentName:"p"},"slug")," from the url ",(0,r.kt)("strong",{parentName:"p"},"only")," works when using the ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"[[...path]].js "),"catch-all route style.")),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"SPA Data Fetching",src:a(2890).Z,width:"1900",height:"817"})),(0,r.kt)("p",null,"Without server-side data fetching, the experience gets clunky and web vitals are greatly affected as there will be a high CLS. SEO is also affected since there is no content or SEO meta tags until the browser fetches the data."),(0,r.kt)("p",null,"The framework data fetching layer is \u201cisomorphic\u201d, you start with client-side data fetching and then opt-in for data that must be pre-fetched on the server. There are a few benefits of this approach:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"It\u2019s possible to easily switch between pre-fetched and non-prefetched data"),(0,r.kt)("li",{parentName:"ul"},'You can pre-fetch on the server and re-fetch on the client, for instance, you might want to re-fetch the "most recent posts" block on the homepage.'),(0,r.kt)("li",{parentName:"ul"},"Mitigate prop-drilling, no need to pass post props to every component as you can simply call the custom hooks (as long as the params match what's being queried for).")),(0,r.kt)("p",null,"It is important to note that ",(0,r.kt)("strong",{parentName:"p"},"you should always pre-fetch on the server the \u201cmain query\u201d and/or the \u201ccore\u201d data for a page in a headless site"),". That\u2019s what we\u2019ll do next! Keep the ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticPaths")," function commented out and uncomment ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps"),"."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"export async function getStaticProps(context) {\n try {\n\n const settledPromises = await resolveBatch([\n {\n func: fetchHookData(usePost.fetcher(), context, { params: singleParams }),\n },\n { func: fetchHookData(useAppSettings.fetcher(), context), throw: false },\n ]);\n\n return addHookData(settledPromises, { revalidate: 5 * 60 });\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps")," is a Next.js method used when you want to pre-render a page on the server at build time or ",(0,r.kt)("a",{parentName:"p",href:"https://nextjs.org/learn/basic-features/data-fetching/incremental-static-regeneration"},"on-demand via ISR"),"."),(0,r.kt)("p",null,"To enable pre-rendering of this route all we need to do is pre-fetch all of the data needed for the framework\u2019s custom hooks. There are two hooks we need to pre-fetch data for, ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettings"),". The ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettings")," hook is responsible for fetching general settings and menu data. The Nav.js component depends on ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettings")," and if we don\u2019t pre-fetch data for it, the menu will be fetched on the client side only."),(0,r.kt)("p",null,"The function responsible for pre-fetching data is ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData"),". It accepts the following params:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"A fetcher strategy that you can get via ",(0,r.kt)("inlineCode",{parentName:"li"},"usePost.fetcher()")),(0,r.kt)("li",{parentName:"ul"},"The next.js context. It is used to extract parameters from the URL among other things."),(0,r.kt)("li",{parentName:"ul"},"An object containing the params. The params must match the params being used by the hooks, otherwise, there will be a key mismatch and data would be pre-fetched for the wrong set of params.")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"resolveBatch")," function is just a utility function that lets you run multiple promises in parallel and select which ones you don\u2019t want to throw errors for. In this case, we\u2019re ignoring the error potentially thrown by ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettings.fetcher()")," the reason being that this hook requires the Headless WordPress plugin, and therefore disabling that plugin would cause a crash on the site if we don\u2019t ignore errors thrown by ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettings.fetcher()"),". Ultimately, it is up to your to decide how to handle errors, we just give you the tools to make your job easier."),(0,r.kt)("p",null,"Next, we have the ",(0,r.kt)("inlineCode",{parentName:"p"},"addHookData"),' function which expects an array of "hook data" (i.e pre-fetched data for the custom hooks returned by ',(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData"),"). The ",(0,r.kt)("inlineCode",{parentName:"p"},"addHookData")," will simply put the results on the cache and hydrate the custom hook with pre-fetched data. The second param is an object that represents the Next.js props you can return from ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"getServerSideProps"),"."),(0,r.kt)("p",null,"If anything fails, we call the ",(0,r.kt)("inlineCode",{parentName:"p"},"handleError")," function which provides standard error handling such as rendering a 404 page if a page is not found and optionally handling redirects (if the redirect strategy is set to 404 in headstartwp.config.js)."),(0,r.kt)("p",null,"Lastly, the ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticPaths")," will return an array of paths that should be pre-rendered at build time. This should only be used in conjunction with getStaticProps. Note that the framework doesn\u2019t force getStaticProps you can use getServerSideProps (especially if your hosting doesn\u2019t provide good support for ISR)."),(0,r.kt)("p",null,"One benefit of pre-rendering (a subset of your pages) at build time is that it can catch a lot of runtime issues since undefined/type errors among others would be caught at build time in your CI."),(0,r.kt)("h2",{id:"main-query-queried-object-and-seo-handling"},"Main Query, Queried Object, and SEO handling."),(0,r.kt)("p",null,"At this point, you might be wondering how the framework handles SEO integration. It does so by using the ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head")," (or ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head_json")," object) added by the Yoast plugin to every resource in the REST API. It works for both single pages and archive pages. The ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head_json")," from either the main query or the queried object is used to populate the page\u2019s meta tags."),(0,r.kt)("p",null,'The "Main Query" is the query that draws parameters from the URL. For example, in ',(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/[...path].js"),", the usePost is the main query since it extracts parameters from the URL. Therefore the yoast_head_json associated with the resource returned by usePost is used to populate the page's SEO meta tags. This allows for additional data to be fetched with other custom hooks without messing with the SEO meta tags for the page."),(0,r.kt)("p",null,'For instance, you might want to display an array of related posts at the bottom of the single post template, since this doesn\u2019t represent the "main query" of the page it won\u2019t be used to populate the page\'s SEO meta tags.'),(0,r.kt)("p",null,'There\u2019s also the concept of "queried object" which is very similar to ',(0,r.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/reference/functions/get_queried_object/"},"get_queried_object()"),' function in WP. It returns the resource that is being "queried for". For instance, in a category archive page, the queried object represents the category that\'s being queried for.'),(0,r.kt)("p",null,"Let's take a look at ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/develop/projects/wp-nextjs/src/pages/category/%5B...path%5D.js"},"src/pages/category/[...path].js")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/category/[...path].js"',title:'"src/pages/category/[...path].js"'},"import { usePosts } from '@headstartwp/next';\n\nconst CategoryPage = () => {\n const { data } = usePosts({ taxonomy: 'category' });\n\n return (\n <>\n

Category Page: {data.queriedObject.term.name}

\n
    \n {data.posts.map((post) => (\n
  • \n {post.title.rendered}\n
  • \n ))}\n
\n \n \n );\n};\n")),(0,r.kt)("p",null,"In this route, we're fetching a list of posts that belong to the category taxonomy. Note that again, we're not passing the category slug, it\u2019s automatically inferred by the framework."),(0,r.kt)("p",null,"Since we\u2019re querying posts that belong to a specific category, ",(0,r.kt)("inlineCode",{parentName:"p"},"data.queriedObject"),' is available with a term object representing the queried category. You will note that this route follows the same "pattern" from ',(0,r.kt)("inlineCode",{parentName:"p"},"src/[...path].js"),"."),(0,r.kt)("p",null,"Take some time to review the other routes, did you spot the pattern?"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Fetch data on the client using the framework\u2019s custom hooks"),(0,r.kt)("li",{parentName:"ul"},"Pre-fetch the data on the server matching the params object.")),(0,r.kt)("h2",{id:"should-you-handle-loadingerror-states-on-the-client"},"Should you handle loading/error states on the client?"),(0,r.kt)("p",null,"As you might have noticed, the category route is not handling errors and loading states on the client. Therefore it assumes the data will always be pre-fetched on the server. If you remove ",(0,r.kt)("inlineCode",{parentName:"p"},"getServerSideProps"),", you will see the following error."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"data-error",src:a(4499).Z,width:"1016",height:"479"})),(0,r.kt)("p",null,"At 10up, we strongly believe that a great developer experience increases developer productivity! Therefore the framework will try to help you, the developer, as much as it can."),(0,r.kt)("p",null,"In this case, it \"detects\" that you\u2019re trying to access something that's returned by the custom hook but is not yet available. As the error message suggests, you need to either handle the loading/error states or pre-fetch the data on the server. We didn't see this error on the single post route because loading/error states are being handled on that route!"),(0,r.kt)("p",null,"So as long as you're pre-fetching data on the server you do not need to handle loading/error states on the client."),(0,r.kt)("p",null,"One way to make things more consistent and your code more resilient without directly handling loading states is by using Suspense, however, that is not fully supported in Next.js and the framework itself (but it will!)."))}d.isMDXComponent=!0},4499:(e,t,a)=>{a.d(t,{Z:()=>n});const n=a.p+"assets/images/error-3ed1849400bc19eb2faa27512eef44c7.png"},2890:(e,t,a)=>{a.d(t,{Z:()=>n});const n=a.p+"assets/images/spa-data-fetching-1-57ac198c0190058bf0a30abfa7ccd060.gif"}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8989],{3905:(e,t,a)=>{a.d(t,{Zo:()=>h,kt:()=>g});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function s(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var l=n.createContext({}),p=function(e){var t=n.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):s(s({},t),e)),a},h=function(e){var t=p(e.components);return n.createElement(l.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},c=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,h=i(e,["components","mdxType","originalType","parentName"]),d=p(a),c=r,g=d["".concat(l,".").concat(c)]||d[c]||u[c]||o;return a?n.createElement(g,s(s({ref:t},h),{},{components:a})):n.createElement(g,s({ref:t},h))}));function g(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=a.length,s=new Array(o);s[0]=c;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[d]="string"==typeof e?e:r,s[1]=i;for(var p=2;p{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var n=a(7462),r=(a(7294),a(3905));const o={slug:"/getting-started/quick-tutorial"},s="Quick Introduction to the Framework",i={unversionedId:"Getting Started/quick-tutorial",id:"Getting Started/quick-tutorial",title:"Quick Introduction to the Framework",description:"Introduction",source:"@site/documentation/01-Getting Started/quick-tutorial.md",sourceDirName:"01-Getting Started",slug:"/getting-started/quick-tutorial",permalink:"/docs/learn/getting-started/quick-tutorial",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/01-Getting Started/quick-tutorial.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{slug:"/getting-started/quick-tutorial"},sidebar:"tutorialSidebar",previous:{title:"Installing WordPress Plugin",permalink:"/docs/learn/getting-started/installing-wordpress-plugin"},next:{title:"Introduction",permalink:"/docs/learn/data-fetching"}},l={},p=[{value:"Introduction",id:"introduction",level:2},{value:"How Routing Works",id:"how-routing-works",level:2},{value:"Basic Data Fetching",id:"basic-data-fetching",level:3},{value:"Main Query, Queried Object, and SEO handling.",id:"main-query-queried-object-and-seo-handling",level:2},{value:"Should you handle loading/error states on the client?",id:"should-you-handle-loadingerror-states-on-the-client",level:2}],h={toc:p};function d(e){let{components:t,...o}=e;return(0,r.kt)("wrapper",(0,n.Z)({},h,o,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"quick-introduction-to-the-framework"},"Quick Introduction to the Framework"),(0,r.kt)("h2",{id:"introduction"},"Introduction"),(0,r.kt)("p",null,"If you\u2019re familiar with Next.js you probably already know that it has a file-system-based router. The routes are declared under the ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages")," folder. To learn more about Next.js routing, read the ",(0,r.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/routing/introduction"},"official docs"),"."),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"the ",(0,r.kt)("inlineCode",{parentName:"p"},"app")," folder is currently not supported by HeadstartWP. Support for new Next.js 13 features, including the app directory, are underway.")),(0,r.kt)("p",null,"HeadstartWP takes advantage of Next.js routing by leveraging a feature called \u201ccatch-all routes\u201d which allows the framework to automatically map URL segments to WordPress routes and the proper REST API parameters necessary to fetch the appropriate data. It does so by adopting a convention of using a \u201ccatch-all\u201d route named ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"[[...path]].js"),"."),(0,r.kt)("h2",{id:"how-routing-works"},"How Routing Works"),(0,r.kt)("p",null,"To understand how routing works in the framework, let\u2019s take a look at the route in the starter project (",(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/develop/projects/wp-nextjs/src/pages/%5B...path%5D.js"},"src/pages/[...path].js"),") that corresponds to a single post/page template (single.php) in WordPress."),(0,r.kt)("p",null,"First, note that it is using single brackets and not double brackets. That is because we only want to \u201ccatch\u201d that route if no other top-level route is matched (such as ",(0,r.kt)("inlineCode",{parentName:"p"},"index.js"),"). Therefore, any route in the form of /post-name or /2022/10/1 will match ",(0,r.kt)("inlineCode",{parentName:"p"},"src/[...path].js"),". You can confirm this by opening any post by either the /post-name route or the date route depending on how your permalinks settings are set up in WordPress E.g:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://headless-framework.vercel.app/2020/05/07/distinctio-rerum-ratione-maxime-repudiandae-laboriosam-quam"},"https://headless-framework.vercel.app/2020/05/07/distinctio-rerum-ratione-maxime-repudiandae-laboriosam-quam")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://headless-framework.vercel.app/distinctio-rerum-ratione-maxime-repudiandae-laboriosam-quam"},"https://headless-framework.vercel.app/distinctio-rerum-ratione-maxime-repudiandae-laboriosam-quam"))),(0,r.kt)("p",null,"The great thing about this is that you don\u2019t need multiple Next.js routes to handle the same resource!"),(0,r.kt)("h3",{id:"basic-data-fetching"},"Basic Data Fetching"),(0,r.kt)("p",null,"Now let\u2019s look at how data fetching for this route works. To make things easier to understand, let\u2019s disregard ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticPaths")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps")," functions."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/params.js"',title:'"src/params.js"'},"/**\n * @type {import('@headstartwp/core').PostParams}\n */\nexport const singleParams = { postType: ['page', 'post'] };\n")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"import { usePost } from '@headstartwp/next';\n\nconst SinglePostsPage = () => {\n const { loading, error } = usePost(singleParams);\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n \n
\n );\n};\n")),(0,r.kt)("p",null,"At this point, the page is not rendered on the server (or at build time) at all. Therefore this route is behaving like a single-page application."),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," hook is one of the framework's data-fetching hooks. As its name suggests it fetches a single post for a given set of params. We\u2019re passing one param called ",(0,r.kt)("inlineCode",{parentName:"p"},"postType"),', which is telling the hook to fetch the current page from either the "page" or "post" post type. Note that we\'re not passing the slug. Passing the slug is optional and if you don\'t pass the slug, the framework will automatically extract the post/page slug from the URL, if present.'),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"Extracting the ",(0,r.kt)("em",{parentName:"p"},"slug")," from the url ",(0,r.kt)("strong",{parentName:"p"},"only")," works when using the ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"[[...path]].js "),"catch-all route style.")),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"SPA Data Fetching",src:a(2890).Z,width:"1900",height:"817"})),(0,r.kt)("p",null,"Without server-side data fetching, the experience gets clunky and web vitals are greatly affected as there will be a high CLS. SEO is also affected since there is no content or SEO meta tags until the browser fetches the data."),(0,r.kt)("p",null,"The framework data fetching layer is \u201cisomorphic\u201d, you start with client-side data fetching and then opt-in for data that must be pre-fetched on the server. There are a few benefits of this approach:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"It\u2019s possible to easily switch between pre-fetched and non-prefetched data"),(0,r.kt)("li",{parentName:"ul"},'You can pre-fetch on the server and re-fetch on the client, for instance, you might want to re-fetch the "most recent posts" block on the homepage.'),(0,r.kt)("li",{parentName:"ul"},"Mitigate prop-drilling, no need to pass post props to every component as you can simply call the custom hooks (as long as the params match what's being queried for).")),(0,r.kt)("p",null,"It is important to note that ",(0,r.kt)("strong",{parentName:"p"},"you should always pre-fetch on the server the \u201cmain query\u201d and/or the \u201ccore\u201d data for a page in a headless site"),". That\u2019s what we\u2019ll do next! Keep the ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticPaths")," function commented out and uncomment ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps"),"."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"export async function getStaticProps(context) {\n try {\n\n const settledPromises = await resolveBatch([\n {\n func: fetchHookData(usePost.fetcher(), context, { params: singleParams }),\n },\n { func: fetchHookData(useAppSettings.fetcher(), context), throw: false },\n ]);\n\n return addHookData(settledPromises, { revalidate: 5 * 60 });\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps")," is a Next.js method used when you want to pre-render a page on the server at build time or ",(0,r.kt)("a",{parentName:"p",href:"https://nextjs.org/learn/basic-features/data-fetching/incremental-static-regeneration"},"on-demand via ISR"),"."),(0,r.kt)("p",null,"To enable pre-rendering of this route all we need to do is pre-fetch all of the data needed for the framework\u2019s custom hooks. There are two hooks we need to pre-fetch data for, ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettings"),". The ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettings")," hook is responsible for fetching general settings and menu data. The Nav.js component depends on ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettings")," and if we don\u2019t pre-fetch data for it, the menu will be fetched on the client side only."),(0,r.kt)("p",null,"The function responsible for pre-fetching data is ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData"),". It accepts the following params:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"A fetcher strategy that you can get via ",(0,r.kt)("inlineCode",{parentName:"li"},"usePost.fetcher()")),(0,r.kt)("li",{parentName:"ul"},"The next.js context. It is used to extract parameters from the URL among other things."),(0,r.kt)("li",{parentName:"ul"},"An object containing the params. The params must match the params being used by the hooks, otherwise, there will be a key mismatch and data would be pre-fetched for the wrong set of params.")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"resolveBatch")," function is just a utility function that lets you run multiple promises in parallel and select which ones you don\u2019t want to throw errors for. In this case, we\u2019re ignoring the error potentially thrown by ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettings.fetcher()")," the reason being that this hook requires the Headless WordPress plugin, and therefore disabling that plugin would cause a crash on the site if we don\u2019t ignore errors thrown by ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettings.fetcher()"),". Ultimately, it is up to your to decide how to handle errors, we just give you the tools to make your job easier."),(0,r.kt)("p",null,"Next, we have the ",(0,r.kt)("inlineCode",{parentName:"p"},"addHookData"),' function which expects an array of "hook data" (i.e pre-fetched data for the custom hooks returned by ',(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData"),"). The ",(0,r.kt)("inlineCode",{parentName:"p"},"addHookData")," will simply put the results on the cache and hydrate the custom hook with pre-fetched data. The second param is an object that represents the Next.js props you can return from ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"getServerSideProps"),"."),(0,r.kt)("p",null,"If anything fails, we call the ",(0,r.kt)("inlineCode",{parentName:"p"},"handleError")," function which provides standard error handling such as rendering a 404 page if a page is not found and optionally handling redirects (if the redirect strategy is set to 404 in headstartwp.config.js)."),(0,r.kt)("p",null,"Lastly, the ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticPaths")," will return an array of paths that should be pre-rendered at build time. This should only be used in conjunction with getStaticProps. Note that the framework doesn\u2019t force getStaticProps you can use getServerSideProps (especially if your hosting doesn\u2019t provide good support for ISR)."),(0,r.kt)("p",null,"One benefit of pre-rendering (a subset of your pages) at build time is that it can catch a lot of runtime issues since undefined/type errors among others would be caught at build time in your CI."),(0,r.kt)("h2",{id:"main-query-queried-object-and-seo-handling"},"Main Query, Queried Object, and SEO handling."),(0,r.kt)("p",null,"At this point, you might be wondering how the framework handles SEO integration. It does so by using the ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head")," (or ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head_json")," object) added by the Yoast plugin to every resource in the REST API. It works for both single pages and archive pages. The ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head_json")," from either the main query or the queried object is used to populate the page\u2019s meta tags."),(0,r.kt)("p",null,'The "Main Query" is the query that draws parameters from the URL. For example, in ',(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/[...path].js"),", the usePost is the main query since it extracts parameters from the URL. Therefore the yoast_head_json associated with the resource returned by usePost is used to populate the page's SEO meta tags. This allows for additional data to be fetched with other custom hooks without messing with the SEO meta tags for the page."),(0,r.kt)("p",null,'For instance, you might want to display an array of related posts at the bottom of the single post template, since this doesn\u2019t represent the "main query" of the page it won\u2019t be used to populate the page\'s SEO meta tags.'),(0,r.kt)("p",null,'There\u2019s also the concept of "queried object" which is very similar to ',(0,r.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/reference/functions/get_queried_object/"},"get_queried_object()"),' function in WP. It returns the resource that is being "queried for". For instance, in a category archive page, the queried object represents the category that\'s being queried for.'),(0,r.kt)("p",null,"Let's take a look at ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/develop/projects/wp-nextjs/src/pages/category/%5B...path%5D.js"},"src/pages/category/[...path].js")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/category/[...path].js"',title:'"src/pages/category/[...path].js"'},"import { usePosts } from '@headstartwp/next';\n\nconst CategoryPage = () => {\n const { data } = usePosts({ taxonomy: 'category' });\n\n return (\n <>\n

Category Page: {data.queriedObject.term.name}

\n
    \n {data.posts.map((post) => (\n
  • \n {post.title.rendered}\n
  • \n ))}\n
\n \n \n );\n};\n")),(0,r.kt)("p",null,"In this route, we're fetching a list of posts that belong to the category taxonomy. Note that again, we're not passing the category slug, it\u2019s automatically inferred by the framework."),(0,r.kt)("p",null,"Since we\u2019re querying posts that belong to a specific category, ",(0,r.kt)("inlineCode",{parentName:"p"},"data.queriedObject"),' is available with a term object representing the queried category. You will note that this route follows the same "pattern" from ',(0,r.kt)("inlineCode",{parentName:"p"},"src/[...path].js"),"."),(0,r.kt)("p",null,"Take some time to review the other routes, did you spot the pattern?"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Fetch data on the client using the framework\u2019s custom hooks"),(0,r.kt)("li",{parentName:"ul"},"Pre-fetch the data on the server matching the params object.")),(0,r.kt)("h2",{id:"should-you-handle-loadingerror-states-on-the-client"},"Should you handle loading/error states on the client?"),(0,r.kt)("p",null,"As you might have noticed, the category route is not handling errors and loading states on the client. Therefore it assumes the data will always be pre-fetched on the server. If you remove ",(0,r.kt)("inlineCode",{parentName:"p"},"getServerSideProps"),", you will see the following error."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"data-error",src:a(4499).Z,width:"1016",height:"479"})),(0,r.kt)("p",null,"At 10up, we strongly believe that a great developer experience increases developer productivity! Therefore the framework will try to help you, the developer, as much as it can."),(0,r.kt)("p",null,"In this case, it \"detects\" that you\u2019re trying to access something that's returned by the custom hook but is not yet available. As the error message suggests, you need to either handle the loading/error states or pre-fetch the data on the server. We didn't see this error on the single post route because loading/error states are being handled on that route!"),(0,r.kt)("p",null,"So as long as you're pre-fetching data on the server you do not need to handle loading/error states on the client."),(0,r.kt)("p",null,"One way to make things more consistent and your code more resilient without directly handling loading states is by using Suspense, however, that is not fully supported in Next.js and the framework itself (but it will!)."))}d.isMDXComponent=!0},4499:(e,t,a)=>{a.d(t,{Z:()=>n});const n=a.p+"assets/images/error-3ed1849400bc19eb2faa27512eef44c7.png"},2890:(e,t,a)=>{a.d(t,{Z:()=>n});const n=a.p+"assets/images/spa-data-fetching-1-57ac198c0190058bf0a30abfa7ccd060.gif"}}]); \ No newline at end of file diff --git a/assets/js/3d28897f.712ecfa4.js b/assets/js/3d28897f.ed9bc0ce.js similarity index 90% rename from assets/js/3d28897f.712ecfa4.js rename to assets/js/3d28897f.ed9bc0ce.js index 1d8b916fa..f0a44367d 100644 --- a/assets/js/3d28897f.712ecfa4.js +++ b/assets/js/3d28897f.ed9bc0ce.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1552],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>f});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function p(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),l=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=l(e.components);return a.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,p=e.originalType,s=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),d=l(r),k=n,f=d["".concat(s,".").concat(k)]||d[k]||u[k]||p;return r?a.createElement(f,i(i({ref:t},c),{},{components:r})):a.createElement(f,i({ref:t},c))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var p=r.length,i=new Array(p);i[0]=k;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[d]="string"==typeof e?e:n,i[1]=o;for(var l=2;l{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>d,frontMatter:()=>p,metadata:()=>o,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const p={id:"headstartwp_core.react.Typography",title:"Interface: Typography",sidebar_label:"@headstartwp/core.react.Typography",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.Typography",id:"interfaces/headstartwp_core.react.Typography",title:"Interface: Typography",description:"@headstartwp/core.react.Typography",source:"@site/docs/interfaces/headstartwp_core.react.Typography.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.Typography",permalink:"/docs/api/interfaces/headstartwp_core.react.Typography",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.Typography",title:"Interface: Typography",sidebar_label:"@headstartwp/core.react.Typography",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.TableBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},next:{title:"@headstartwp/core.react.VerseBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"}},s={},l=[{value:"Properties",id:"properties",level:2},{value:"fontSize",id:"fontsize",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"letterSpacing",id:"letterspacing",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"lineHeight",id:"lineheight",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"supportsCustomFontSize",id:"supportscustomfontsize",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"supportsFontStyle",id:"supportsfontstyle",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"supportsFontWeight",id:"supportsfontweight",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"supportsLetterSpacing",id:"supportsletterspacing",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"supportsLineHeight",id:"supportslineheight",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"supportsTextDecoration",id:"supportstextdecoration",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"supportsTextTransform",id:"supportstexttransform",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"textTransform",id:"texttransform",level:3},{value:"Defined in",id:"defined-in-10",level:4}],c={toc:l};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".Typography"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"fontsize"},"fontSize"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"fontSize"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"slug")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"value")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L24"},"packages/core/src/react/blocks/types.ts:24")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"letterspacing"},"letterSpacing"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"letterSpacing"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L37"},"packages/core/src/react/blocks/types.ts:37")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"lineheight"},"lineHeight"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"lineHeight"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L35"},"packages/core/src/react/blocks/types.ts:35")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportscustomfontsize"},"supportsCustomFontSize"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsCustomFontSize"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L29"},"packages/core/src/react/blocks/types.ts:29")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportsfontstyle"},"supportsFontStyle"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsFontStyle"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L28"},"packages/core/src/react/blocks/types.ts:28")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportsfontweight"},"supportsFontWeight"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsFontWeight"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L30"},"packages/core/src/react/blocks/types.ts:30")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportsletterspacing"},"supportsLetterSpacing"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsLetterSpacing"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L31"},"packages/core/src/react/blocks/types.ts:31")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportslineheight"},"supportsLineHeight"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsLineHeight"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L32"},"packages/core/src/react/blocks/types.ts:32")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportstextdecoration"},"supportsTextDecoration"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsTextDecoration"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L33"},"packages/core/src/react/blocks/types.ts:33")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportstexttransform"},"supportsTextTransform"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsTextTransform"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L34"},"packages/core/src/react/blocks/types.ts:34")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"texttransform"},"textTransform"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"textTransform"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L36"},"packages/core/src/react/blocks/types.ts:36")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1552],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function p(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),l=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=l(e.components);return a.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,p=e.originalType,s=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),d=l(r),k=n,h=d["".concat(s,".").concat(k)]||d[k]||u[k]||p;return r?a.createElement(h,i(i({ref:t},c),{},{components:r})):a.createElement(h,i({ref:t},c))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var p=r.length,i=new Array(p);i[0]=k;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[d]="string"==typeof e?e:n,i[1]=o;for(var l=2;l{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>d,frontMatter:()=>p,metadata:()=>o,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const p={id:"headstartwp_core.react.Typography",title:"Interface: Typography",sidebar_label:"@headstartwp/core.react.Typography",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.Typography",id:"interfaces/headstartwp_core.react.Typography",title:"Interface: Typography",description:"@headstartwp/core.react.Typography",source:"@site/docs/interfaces/headstartwp_core.react.Typography.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.Typography",permalink:"/docs/api/interfaces/headstartwp_core.react.Typography",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.Typography",title:"Interface: Typography",sidebar_label:"@headstartwp/core.react.Typography",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.TableBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},next:{title:"@headstartwp/core.react.VerseBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"}},s={},l=[{value:"Properties",id:"properties",level:2},{value:"fontSize",id:"fontsize",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"letterSpacing",id:"letterspacing",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"lineHeight",id:"lineheight",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"supportsCustomFontSize",id:"supportscustomfontsize",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"supportsFontStyle",id:"supportsfontstyle",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"supportsFontWeight",id:"supportsfontweight",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"supportsLetterSpacing",id:"supportsletterspacing",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"supportsLineHeight",id:"supportslineheight",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"supportsTextDecoration",id:"supportstextdecoration",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"supportsTextTransform",id:"supportstexttransform",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"textTransform",id:"texttransform",level:3},{value:"Defined in",id:"defined-in-10",level:4}],c={toc:l};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".Typography"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"fontsize"},"fontSize"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"fontSize"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"slug")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"value")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L24"},"packages/core/src/react/blocks/types.ts:24")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"letterspacing"},"letterSpacing"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"letterSpacing"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L37"},"packages/core/src/react/blocks/types.ts:37")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"lineheight"},"lineHeight"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"lineHeight"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L35"},"packages/core/src/react/blocks/types.ts:35")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportscustomfontsize"},"supportsCustomFontSize"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsCustomFontSize"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L29"},"packages/core/src/react/blocks/types.ts:29")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportsfontstyle"},"supportsFontStyle"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsFontStyle"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L28"},"packages/core/src/react/blocks/types.ts:28")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportsfontweight"},"supportsFontWeight"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsFontWeight"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L30"},"packages/core/src/react/blocks/types.ts:30")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportsletterspacing"},"supportsLetterSpacing"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsLetterSpacing"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L31"},"packages/core/src/react/blocks/types.ts:31")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportslineheight"},"supportsLineHeight"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsLineHeight"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L32"},"packages/core/src/react/blocks/types.ts:32")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportstextdecoration"},"supportsTextDecoration"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsTextDecoration"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L33"},"packages/core/src/react/blocks/types.ts:33")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportstexttransform"},"supportsTextTransform"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsTextTransform"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L34"},"packages/core/src/react/blocks/types.ts:34")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"texttransform"},"textTransform"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"textTransform"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L36"},"packages/core/src/react/blocks/types.ts:36")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/44b9bd65.35d636a8.js b/assets/js/44b9bd65.dfdcfcf4.js similarity index 97% rename from assets/js/44b9bd65.35d636a8.js rename to assets/js/44b9bd65.dfdcfcf4.js index 40fab7ca6..521f00606 100644 --- a/assets/js/44b9bd65.35d636a8.js +++ b/assets/js/44b9bd65.dfdcfcf4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3126],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>u});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var d=n.createContext({}),o=function(e){var t=n.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},s=function(e){var t=o(e.components);return n.createElement(d.Provider,{value:t},e.children)},k="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},N=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,d=e.parentName,s=i(e,["components","mdxType","originalType","parentName"]),k=o(a),N=r,u=k["".concat(d,".").concat(N)]||k[N]||m[N]||l;return a?n.createElement(u,p(p({ref:t},s),{},{components:a})):n.createElement(u,p({ref:t},s))}));function u(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,p=new Array(l);p[0]=N;var i={};for(var d in t)hasOwnProperty.call(t,d)&&(i[d]=t[d]);i.originalType=e,i[k]="string"==typeof e?e:r,p[1]=i;for(var o=2;o{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>k,frontMatter:()=>l,metadata:()=>i,toc:()=>o});var n=a(7462),r=(a(7294),a(3905));const l={id:"headstartwp_next",title:"Module: @headstartwp/next",sidebar_label:"@headstartwp/next",sidebar_position:0,custom_edit_url:null},p=void 0,i={unversionedId:"modules/headstartwp_next",id:"modules/headstartwp_next",title:"Module: @headstartwp/next",description:"Namespaces",source:"@site/docs/modules/headstartwp_next.md",sourceDirName:"modules",slug:"/modules/headstartwp_next",permalink:"/docs/api/modules/headstartwp_next",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"headstartwp_next",title:"Module: @headstartwp/next",sidebar_label:"@headstartwp/next",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core",permalink:"/docs/api/modules/headstartwp_core"},next:{title:"@headstartwp/core.react",permalink:"/docs/api/namespaces/headstartwp_core.react"}},d={},o=[{value:"Namespaces",id:"namespaces",level:2},{value:"Interfaces",id:"interfaces",level:2},{value:"API handlers",id:"api-handlers",level:2},{value:"previewHandler",id:"previewhandler",level:3},{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"revalidateHandler",id:"revalidatehandler",level:3},{value:"Usage",id:"usage-1",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"Data Fetching Hooks",id:"data-fetching-hooks",level:2},{value:"useAppSettings",id:"useappsettings",level:3},{value:"Usage",id:"usage-2",level:2},{value:"Server-Side-Rendering or Static-Site-Generation",id:"server-side-rendering-or-static-site-generation",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"useAuthorArchive",id:"useauthorarchive",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"useMenu",id:"usemenu",level:3},{value:"Usage",id:"usage-3",level:2},{value:"Basic usage",id:"basic-usage",level:3},{value:"Re-fetching client-side on focus and/or mount",id:"re-fetching-client-side-on-focus-andor-mount",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"usePost",id:"usepost",level:3},{value:"Type parameters",id:"type-parameters-2",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"usePostOrPosts",id:"usepostorposts",level:3},{value:"Type parameters",id:"type-parameters-3",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"usePosts",id:"useposts",level:3},{value:"Handling multiple WordPress routes in a single next.js route",id:"handling-multiple-wordpress-routes-in-a-single-nextjs-route",level:3},{value:"Type parameters",id:"type-parameters-4",level:4},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"useSearch",id:"usesearch",level:3},{value:"Type parameters",id:"type-parameters-5",level:4},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"useSeo",id:"useseo",level:3},{value:"Usage",id:"usage-4",level:2},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"useTerms",id:"useterms",level:3},{value:"Usage",id:"usage-5",level:2},{value:"Type parameters",id:"type-parameters-6",level:4},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"Next.js Data Fetching Utilities",id:"nextjs-data-fetching-utilities",level:2},{value:"addHookData",id:"addhookdata",level:3},{value:"Usage",id:"usage-6",level:2},{value:"Type parameters",id:"type-parameters-7",level:4},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"convertToPath",id:"converttopath",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"fetchHookData",id:"fetchhookdata",level:3},{value:"Usage",id:"usage-7",level:2},{value:"Type parameters",id:"type-parameters-8",level:4},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"handleError",id:"handleerror",level:3},{value:"Usage",id:"usage-8",level:2},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"Other",id:"other",level:2},{value:"HeadlessAppProps",id:"headlessappprops",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"HeadlessGetServerSideProps",id:"headlessgetserversideprops",level:3},{value:"Type parameters",id:"type-parameters-9",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"HeadlessGetServerSidePropsContext",id:"headlessgetserversidepropscontext",level:3},{value:"Type parameters",id:"type-parameters-10",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"HeadlessGetStaticProps",id:"headlessgetstaticprops",level:3},{value:"Type parameters",id:"type-parameters-11",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"HeadlessGetStaticPropsPropsContext",id:"headlessgetstaticpropspropscontext",level:3},{value:"Type parameters",id:"type-parameters-12",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"HookState",id:"hookstate",level:3},{value:"Type parameters",id:"type-parameters-13",level:4},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"NextJSProps",id:"nextjsprops",level:3},{value:"Type parameters",id:"type-parameters-14",level:4},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"PreviewData",id:"previewdata",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"PreviewHandlerOptions",id:"previewhandleroptions",level:3},{value:"Type declaration",id:"type-declaration-4",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"VIPCustomImageLoader",id:"vipcustomimageloader",level:3},{value:"Defined in",id:"defined-in-26",level:4},{value:"seoKey",id:"seokey",level:3},{value:"Defined in",id:"defined-in-27",level:4},{value:"VIPImageLoader",id:"vipimageloader",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"convertUrl",id:"converturl",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"getPathName",id:"getpathname",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"getSiteFromContext",id:"getsitefromcontext",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Defined in",id:"defined-in-31",level:4},{value:"usePrepareFetch",id:"usepreparefetch",level:3},{value:"Type parameters",id:"type-parameters-15",level:4},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Defined in",id:"defined-in-32",level:4},{value:"React Components",id:"react-components",level:2},{value:"HeadlessApp",id:"headlessapp",level:3},{value:"Usage",id:"usage-9",level:2},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-22",level:4},{value:"Defined in",id:"defined-in-33",level:4},{value:"ImageComponent",id:"imagecomponent",level:3},{value:"Usage",id:"usage-10",level:2},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Defined in",id:"defined-in-34",level:4},{value:"LinkBlock",id:"linkblock",level:3},{value:"Usage",id:"usage-11",level:2},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-24",level:4},{value:"Defined in",id:"defined-in-35",level:4},{value:"TwitterBlock",id:"twitterblock",level:3},{value:"Usage",id:"usage-12",level:2},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Defined in",id:"defined-in-36",level:4},{value:"Yoast",id:"yoast",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-26",level:4},{value:"Defined in",id:"defined-in-37",level:4}],s={toc:o};function k(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"namespaces"},"Namespaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/namespaces/headstartwp_next.config"},"config")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/namespaces/headstartwp_next.middlewares"},"middlewares"))),(0,r.kt)("h2",{id:"interfaces"},"Interfaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions"},"FetchHookDataOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_next.ImageProps"},"ImageProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_next.LinkBlockProps"},"LinkBlockProps"))),(0,r.kt)("h2",{id:"api-handlers"},"API handlers"),(0,r.kt)("h3",{id:"previewhandler"},"previewHandler"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"previewHandler"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"req"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"res"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"The PreviewHandler is responsible for handling preview requests."),(0,r.kt)("p",null,"Handling Previews requires the Headless WordPress Plugin."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Important"),": This function is meant to be used in a api route at ",(0,r.kt)("inlineCode",{parentName:"p"},"/pages/api/preview"),"."),(0,r.kt)("h3",{id:"usage"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"// pages/api/preview.js\nimport { previewHandler } from '@headstartwp/next';\n\nexport default async function handler(req, res) {\n return previewHandler(req, res);\n}\n")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"req")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextApiRequest")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The request object,")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"res")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextApiResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The response object.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewhandleroptions"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewHandlerOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The PreviewHandlerOptions ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewhandleroptions"},"PreviewHandlerOptions"))))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"A response object."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/handlers/previewHandler.ts#L120"},"packages/next/src/handlers/previewHandler.ts:120")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"revalidatehandler"},"revalidateHandler"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"revalidateHandler"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"req"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"res"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"The RevalidateHandler is responsible for handling revalidate requests."),(0,r.kt)("p",null,"Handling revalidate requires the Headless WordPress Plugin."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Important"),": This function is meant to be used in a api route e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"/pages/api/revalidate"),"."),(0,r.kt)("h3",{id:"usage-1"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"// pages/api/revalidate.js\nimport { revalidateHandler } from '@headstartwp/next';\n\nexport default async function handler(req, res) {\n return revalidateHandler(req, res);\n}\n")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"req")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextApiRequest")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The request object,")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"res")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextApiResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The response object.")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"A response object."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/handlers/revalidateHandler.ts#L30"},"packages/next/src/handlers/revalidateHandler.ts:30")),(0,r.kt)("h2",{id:"data-fetching-hooks"},"Data Fetching Hooks"),(0,r.kt)("h3",{id:"useappsettings"},"useAppSettings"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useAppSettings"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettingsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useAppSettings hook"),(0,r.kt)("h2",{id:"usage-2"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"const { data, loading, error } = useAppSettings();\n\n// check loading and error states\n")),(0,r.kt)("h3",{id:"server-side-rendering-or-static-site-generation"},"Server-Side-Rendering or Static-Site-Generation"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"export async function getServerSideProps(context) {\n const useAppSettingsData = await fetchHookData(useAppSettings.fetcher(), context);\n return addHookData([useAppSettingsData], {});\n}\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Important"),": You most likely want to fetch app settings on every route so\nthat you can access global settings and menus in your pages & components"),(0,r.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"AppEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"AppEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"EndpointParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"EndpointParams"))))),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettingsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/hooks/useAppSettings.ts#L33"},"packages/next/src/data/hooks/useAppSettings.ts:33")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useauthorarchive"},"useAuthorArchive"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useAuthorArchive"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useAuthorArchive hook. Returns a collection of post entities queried by author"),(0,r.kt)("p",null,"This hook must be used with a catch-all route ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," (e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/author/[...path].js"),")"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Important"),": Use a catch-all and not an optional catch-all route (",(0,r.kt)("inlineCode",{parentName:"p"},"[[...path]].js"),") as the author param in the url is required."),(0,r.kt)("p",null,"In order to automatically map URL params create a catch-all route named ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js"),".\nYou can create the catch-all at any level e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/author/[...path].js"),", etc."),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/author/[...path].js")," route for instance would yield a URL like this: ",(0,r.kt)("inlineCode",{parentName:"p"},"/author-name/page/2"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"/author-name/category/category-name/page/3"),", etc."),(0,r.kt)("p",null,"The following URL params are supported:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Category (/author-name/category/category-name)"),(0,r.kt)("li",{parentName:"ul"},"Tag (/author-name/tag/tag-name)"),(0,r.kt)("li",{parentName:"ul"},"Author (/author/author-name)"),(0,r.kt)("li",{parentName:"ul"},"Pagination (/page/2)"),(0,r.kt)("li",{parentName:"ul"},"Custom Taxonomy (/author//taxonomy/term-name)")),(0,r.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams"))))),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"usePostsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/hooks/useAuthorArchive.ts#L29"},"packages/next/src/data/hooks/useAuthorArchive.ts:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usemenu"},"useMenu"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useMenu"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"menuLocation"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"useMenuResponse")),(0,r.kt)("p",null,"The useMenu hooks. Returns a Menu object."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Important"),": This hook depends on ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#useappsettings"},"useAppSettings"),". If you want to enable SSR;SSG for\nthis hook you will need to fetch app settings on the server side."),(0,r.kt)("h2",{id:"usage-3"},"Usage"),(0,r.kt)("h3",{id:"basic-usage"},"Basic usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"export const Nav = () => {\n const { data, loading, error } = useMenu('primary-menu');\n\n // handle loading, error states\n\n return ;\n}\n")),(0,r.kt)("h3",{id:"re-fetching-client-side-on-focus-andor-mount"},"Re-fetching client-side on focus and/or mount"),(0,r.kt)("p",null,"If you are fetching app settings on the server, you can enable re-fetching on focus and/or mount\nto ensure menus are always up-to date even when using SSG/ISR."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"export const Nav = () => {\n const { data, loading, error } = useMenu('primary-menu', {\n revalidateOnFocus: true,\n revalidateOnMount: true,\n });\n\n // handle loading, error states\n\n return ;\n}\n")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"menuLocation")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The slug of the menu location you want to fetch")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"AppEntity"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"SWR configuration options")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"useMenuResponse")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/hooks/useMenu.ts#L46"},"packages/next/src/data/hooks/useMenu.ts:46")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usepost"},"usePost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"usePost"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The usePost hook. Returns a single post entity"),(0,r.kt)("p",null,"In order to automatically map URL params create a catch-all route named ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js"),".\nYou can create the catch-all at any level e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/[...path].js"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/blog/[...path].js"),", etc."),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/[...path].js")," route for instance would yield a URL like this: ",(0,r.kt)("inlineCode",{parentName:"p"},"/post-slug"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"/2020/01/01/post-slug"),", etc."),(0,r.kt)("h4",{id:"type-parameters-2"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostParams"))))),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"usePostResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/hooks/usePost.ts#L18"},"packages/next/src/data/hooks/usePost.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usepostorposts"},"usePostOrPosts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"usePostOrPosts"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostOrPostResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The usePostOrPosts hook"),(0,r.kt)("h4",{id:"type-parameters-3"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostOrPostsParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostOrPostsParams"))))),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PostOrPostsFetchStrategyResult"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"usePostOrPostResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/hooks/usePostOrPosts.ts#L18"},"packages/next/src/data/hooks/usePostOrPosts.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useposts"},"usePosts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"usePosts"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The usePost hook. Returns a collection of post entities"),(0,r.kt)("p",null,"In order to automatically map URL params create a catch-all route named ",(0,r.kt)("inlineCode",{parentName:"p"},"[[...path]].js"),".\nYou can create the catch-all at any level e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/[[...path]].js"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/blog/[[...path]].js"),", etc."),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/blog/[[...path]].js")," route for instance would yield a URL like this: ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog/page/2"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog/category/category-name/page/3"),", etc."),(0,r.kt)("p",null,"The following URL params are supported:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Category (/category/category-name)"),(0,r.kt)("li",{parentName:"ul"},"Tag (/tag/tag-name)"),(0,r.kt)("li",{parentName:"ul"},"Author (/author/author-name)"),(0,r.kt)("li",{parentName:"ul"},"Pagination (/page/2)"),(0,r.kt)("li",{parentName:"ul"},"Date (/YYYY/MM/DD)"),(0,r.kt)("li",{parentName:"ul"},"Custom Taxonomy (/taxonomy/term-name)")),(0,r.kt)("h3",{id:"handling-multiple-wordpress-routes-in-a-single-nextjs-route"},"Handling multiple WordPress routes in a single next.js route"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," hook is very flexible and can handle multiple WordPress routes in a single next.js route when using the optional-catch-all route (",(0,r.kt)("inlineCode",{parentName:"p"},"[[...path]].js"),").\nAlongside with the actual data, ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," also returns information about the current route so you can conditionally load different components."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"const params = { postType: 'post' };\nconst Posts = () => {\n const { data, pageType } = usePosts(params);\n\n if (pageType.isAuthorArchive) {\n return \n }\n\n if (pageType.isCategoryArchive) {\n return \n }\n\n if (pageType.isTaxonomyArchive && pageType.taxonomy === 'my-custom-taxonomy' ) {\n return \n }\n\n return (\n
\n
    \n {data.posts.map((post) => (\n
  • \n {post.title.rendered}\n
  • \n ))}\n
\n
\n );\n};\n")),(0,r.kt)("h4",{id:"type-parameters-4"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams"))))),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"usePostsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/hooks/usePosts.ts#L62"},"packages/next/src/data/hooks/usePosts.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usesearch"},"useSearch"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSearch"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"useSearchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useSearch hook. Returns a collection of search entities"),(0,r.kt)("p",null,"In order to automatically map URL params create a catch-all route named ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js"),".\nYou can create the catch-all at any level e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/search/[[...path]].js")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/search/[[...path]].js")," route for instance would yield a URL like this: ",(0,r.kt)("inlineCode",{parentName:"p"},"/search/[term]/page/[number]"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"/search/[term]")," etc"),(0,r.kt)("h4",{id:"type-parameters-5"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams"))))),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"useSearchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/hooks/useSearch.ts#L18"},"packages/next/src/data/hooks/useSearch.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useseo"},"useSeo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSeo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"format"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("p",null,"The useSeo hook. Returns the current SEO object"),(0,r.kt)("h2",{id:"usage-4"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"const seo = useSeo();\n")),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"format")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},'"json"')),(0,r.kt)("td",{parentName:"tr",align:"left"},"how to return the seo object. Defaults to 'json'")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/hooks/useSeo.ts#L18"},"packages/next/src/data/hooks/useSeo.ts:18")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSeo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"format"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"format")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},'"html"'))))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/hooks/useSeo.ts#L19"},"packages/next/src/data/hooks/useSeo.ts:19")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSeo"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/hooks/useSeo.ts#L20"},"packages/next/src/data/hooks/useSeo.ts:20")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useterms"},"useTerms"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useTerms"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"useTermsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useTerms hook. Returns a collection of term entities"),(0,r.kt)("h2",{id:"usage-5"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"const { loading, data } = useTerms({ taxonomy: 'category', slug: 'cat-name' });\n")),(0,r.kt)("h4",{id:"type-parameters-6"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"TermEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"TermEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"TaxonomyArchiveParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"TaxonomyArchiveParams"))))),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"useTermsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/hooks/useTerms.ts#L19"},"packages/next/src/data/hooks/useTerms.ts:19")),(0,r.kt)("h2",{id:"nextjs-data-fetching-utilities"},"Next.js Data Fetching Utilities"),(0,r.kt)("h3",{id:"addhookdata"},"addHookData"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addHookData"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"_hookStates"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"nextProps"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"addHookData")," function is responsible for collecting all of the results from the ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData")," function calls\nand prepares the shape of the data to match what the frameworks expects (such as setting initial values for SWR and collecting SEO data)."),(0,r.kt)("h2",{id:"usage-6"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"export async function getServerSideProps(context) {\n try {\n const usePostsHook = await fetchHookData(usePosts.fetcher(),context);\n const useAppSettingsHook = await fetchHookData(useAppSettings.fetcher(),context);\n return addHookData([usePostsHook, useAppSettingsHook], {});\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("h4",{id:"type-parameters-7"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"[key: string]"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"; }")))),(0,r.kt)("h4",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"_hookStates")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#hookstate"},(0,r.kt)("inlineCode",{parentName:"a"},"HookState")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Entity")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Entity"),"[]",">",">","[]"),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nextProps")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#nextjsprops"},(0,r.kt)("inlineCode",{parentName:"a"},"NextJSProps")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Any additional props to pass to Next.js page routes.")))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"notFound?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"fallback"),": {} ; ",(0,r.kt)("inlineCode",{parentName:"td"},"seo"),": { ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," = seo; ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head_json"),": {} = seo","_","json } ; ",(0,r.kt)("inlineCode",{parentName:"td"},"themeJSON"),": {} }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props.fallback")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{}")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props.seo")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," = seo; ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head_json"),": {} = seo","_","json }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props.seo.yoast_head")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props.seo.yoast_head_json")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{}")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props.themeJSON")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{}")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirect?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Redirect"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"revalidate?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/server/addHookData.ts#L59"},"packages/next/src/data/server/addHookData.ts:59")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"converttopath"},"convertToPath"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"convertToPath"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"args"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Creates a path from array of arguments"),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Array of catch-all arguments")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/convertToPath.ts#L8"},"packages/next/src/data/convertToPath.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchhookdata"},"fetchHookData"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchHookData"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"R"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"fetchStrategy"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"additionalCacheObjects"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"data"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"R"),">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"isMainQuery"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,r.kt)("p",null,"A function that implements data fetching on the server. This should be used in ",(0,r.kt)("inlineCode",{parentName:"p"},"getServerSideProps"),"\nor ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps"),"."),(0,r.kt)("p",null,"Data fetching will be performed by the specified strategy and URL params will be automatically extracted\nfrom `context"),(0,r.kt)("h2",{id:"usage-7"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"export async function getServerSideProps(context) {\n try {\n const usePostsHook = await fetchHookData(usePosts.fetcher(),context);\n\n return addHookData([usePostsHook], {});\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("p",null,"@param fetchStrategy The fetch strategy to use. Typically this is exposed by the hook e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts.fetcher()"),"\n@param ctx The Next.js context, either the one from ",(0,r.kt)("inlineCode",{parentName:"p"},"getServerSideProps")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps"),"\n@param options See {@link FetchHookDataOptions}"),(0,r.kt)("p",null,"@returns An object with a key of ",(0,r.kt)("inlineCode",{parentName:"p"},"data")," and a value of the fetched data."),(0,r.kt)("h4",{id:"type-parameters-8"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"unknown"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"EndpointParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"EndpointParams"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"R")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))))),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetchStrategy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AbstractFetchStrategy"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"R"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ctx")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"GetServerSidePropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"GetStaticPropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookDataOptions")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"additionalCacheObjects"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"data"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"R"),">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"isMainQuery"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/server/fetchHookData.ts#L81"},"packages/next/src/data/server/fetchHookData.ts:81")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"handleerror"},"handleError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"handleError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"rootRoute?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"GetServerSidePropsResult"),"<{}",">",">"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"handleError")," function is responsible for handling errors that occur during\ndata fetching in ",(0,r.kt)("inlineCode",{parentName:"p"},"getServerSideProps")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps"),"."),(0,r.kt)("p",null,"It also handles redirects if ",(0,r.kt)("inlineCode",{parentName:"p"},"redirectStrategy")," is set to ",(0,r.kt)("inlineCode",{parentName:"p"},"404")," in ",(0,r.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,r.kt)("p",null,"If ",(0,r.kt)("inlineCode",{parentName:"p"},"error")," is of type NotFoundError it will redirect to the 404 page. Otherwise it will\nreturn a server error (500) page"),(0,r.kt)("h2",{id:"usage-8"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"export async function getServerSideProps(context) {\n try {\n const usePostsHook = await fetchHookData(usePosts.fetcher(),context);\n return addHookData([usePostsHook], {});\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("h4",{id:"parameters-15"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The error object")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ctx")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#headlessgetserversidepropscontext"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessGetServerSidePropsContext")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"),">"," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#headlessgetstaticpropspropscontext"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessGetStaticPropsPropsContext")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Next.js context")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"rootRoute")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The root route (deprecated/unnecessary). This needs to be revisited")))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"GetServerSidePropsResult"),"<{}",">",">"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/server/handleError.ts#L61"},"packages/next/src/data/server/handleError.ts:61")),(0,r.kt)("h2",{id:"other"},"Other"),(0,r.kt)("h3",{id:"headlessappprops"},"HeadlessAppProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessAppProps"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The props supported by ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#headlessapp"},"HeadlessApp"),"."),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"children?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ReactNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"handleYoast?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If true, will automatically load yoast seo metadata into the head ",(0,r.kt)("strong",{parentName:"td"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))," true")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pageProps")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The page props from next.js. It should contain ",(0,r.kt)("inlineCode",{parentName:"td"},"fallback"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"themeJson")," and other props. Those props are added when using ",(0,r.kt)("inlineCode",{parentName:"td"},"fetchHookData")," and ",(0,r.kt)("inlineCode",{parentName:"td"},"addHookData")," ",(0,r.kt)("strong",{parentName:"td"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))," - ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#fetchhookdata"},"fetchHookData")," - ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#addhookdata"},"addHookData"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"settings")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SettingsContextProps")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Supported settings by the framework. Such as custom image component, custom link component etc. ",(0,r.kt)("strong",{parentName:"td"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))," SettingsContextProps")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"swrConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"DataFetchingProviderProps"),"[",(0,r.kt)("inlineCode",{parentName:"td"},'"swrConfig"'),"]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Pass any configuration to the SWR library. Globally. These settings can be overridden at the hook level.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"useYoastHtml?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If true, will make the Yoast component use the ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head")," raw html to populate meta tags instead of ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head_json"),". ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head")," is the default and preferable option.")))),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/components/HeadlessApp.tsx#L18"},"packages/next/src/components/HeadlessApp.tsx:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headlessgetserversideprops"},"HeadlessGetServerSideProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessGetServerSideProps"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"GetServerSideProps"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">"),(0,r.kt)("h4",{id:"type-parameters-9"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Object")," = { ",(0,r.kt)("inlineCode",{parentName:"td"},"[key: string]"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"; }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Q")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"))))),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/types.ts#L16"},"packages/next/src/data/types.ts:16")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headlessgetserversidepropscontext"},"HeadlessGetServerSidePropsContext"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessGetServerSidePropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"GetServerSidePropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">"),(0,r.kt)("h4",{id:"type-parameters-10"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Q")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"))))),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/types.ts#L10"},"packages/next/src/data/types.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headlessgetstaticprops"},"HeadlessGetStaticProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessGetStaticProps"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"GetStaticProps"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">"),(0,r.kt)("h4",{id:"type-parameters-11"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Object")," = { ",(0,r.kt)("inlineCode",{parentName:"td"},"[key: string]"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"; }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Q")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"))))),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/types.ts#L21"},"packages/next/src/data/types.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headlessgetstaticpropspropscontext"},"HeadlessGetStaticPropsPropsContext"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessGetStaticPropsPropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"GetStaticPropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">"),(0,r.kt)("h4",{id:"type-parameters-12"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Q")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"))))),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/types.ts#L13"},"packages/next/src/data/types.ts:13")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hookstate"},"HookState"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HookState"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-parameters-13"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))))),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"additionalCacheObjects?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#hookstate"},(0,r.kt)("inlineCode",{parentName:"a"},"HookState")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">","[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isMainQuery")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/server/addHookData.ts#L10"},"packages/next/src/data/server/addHookData.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"nextjsprops"},"NextJSProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"NextJSProps"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-parameters-14"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P"))))),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"notFound?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirect?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Redirect"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"revalidate?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/server/addHookData.ts#L17"},"packages/next/src/data/server/addHookData.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"previewdata"},"PreviewData"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"PreviewData"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The shape of the preview data that's stored in the preview data cookie"),(0,r.kt)("h4",{id:"index-signature"},"Index signature"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"authToken")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The auth token that should be used to fetch the data")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the resource")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"postType")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The post type")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"revision")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether the preview data is on a revision")))),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/handlers/types.ts#L4"},"packages/next/src/handlers/types.ts:4")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"previewhandleroptions"},"PreviewHandlerOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"PreviewHandlerOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The options supported by ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#previewhandler"},"previewHandler")),(0,r.kt)("h4",{id:"type-declaration-4"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"getRedirectPath?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"defaultRedirectPath"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"post"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"postTypeDef"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"CustomPostType"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onRedirect?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"req"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"NextApiRequest"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"res"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"NextApiResponse"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"previewData"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),", ",(0,r.kt)("inlineCode",{parentName:"td"},"defaultRedirect?"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewhandleroptions"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewHandlerOptions")),"[",(0,r.kt)("inlineCode",{parentName:"td"},'"onRedirect"'),"]",", ",(0,r.kt)("inlineCode",{parentName:"td"},"redirectpath?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"preparePreviewData?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"req"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"NextApiRequest"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"res"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"NextApiResponse"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"post"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"previewData"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),") => ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")))))),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/handlers/previewHandler.ts#L11"},"packages/next/src/handlers/previewHandler.ts:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"vipcustomimageloader"},"VIPCustomImageLoader"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"VIPCustomImageLoader"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ImageLoaderProps")," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"aspectRatio?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }"),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/components/ImageComponent.tsx#L30"},"packages/next/src/components/ImageComponent.tsx:30")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"seokey"},"seoKey"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"seoKey"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"@seo"')),(0,r.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/hooks/useSeo.ts#L3"},"packages/next/src/data/hooks/useSeo.ts:3")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"vipimageloader"},"VIPImageLoader"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"VIPImageLoader"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Custom Image loader for WordPress VIP leveraging Photon's API. This can't be made\na global loader because of the local loader used on the custom image component."),(0,r.kt)("h4",{id:"parameters-16"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#vipcustomimageloader"},(0,r.kt)("inlineCode",{parentName:"a"},"VIPCustomImageLoader"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The loader props")))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/components/ImageComponent.tsx#L42"},"packages/next/src/components/ImageComponent.tsx:42")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"converturl"},"convertUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"convertUrl"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"hostUrl"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-17"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hostUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/components/Yoast.tsx#L15"},"packages/next/src/components/Yoast.tsx:15")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getpathname"},"getPathName"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getPathName"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"resolvedUrl"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Extracts the path name out of the Next.js resolvedUrl"),(0,r.kt)("h4",{id:"parameters-18"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"resolvedUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The full resolved URL")))),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/server/handleError.ts#L23"},"packages/next/src/data/server/handleError.ts:23")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsitefromcontext"},"getSiteFromContext"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSiteFromContext"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"HeadlessConfig")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"customPostTypes"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"CustomPostTypes")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customTaxonomies"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"CustomTaxonomies")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"debug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"devMode?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"redirects?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"requests?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"hostUrl"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"integrations"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Integrations")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"redirectStrategy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"RedirectStrategy")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sites"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"HeadlessConfig"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"useWordPressPlugin"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }"),(0,r.kt)("p",null,"Get site using context"),(0,r.kt)("h4",{id:"parameters-19"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ctx")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"GetServerSidePropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"PreviewData"),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"GetStaticPropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"PreviewData"),">")))),(0,r.kt)("h4",{id:"returns-20"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"HeadlessConfig")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"customPostTypes"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"CustomPostTypes")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customTaxonomies"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"CustomTaxonomies")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"debug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"devMode?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"redirects?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"requests?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"hostUrl"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"integrations"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Integrations")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"redirectStrategy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"RedirectStrategy")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sites"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"HeadlessConfig"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"useWordPressPlugin"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }"),(0,r.kt)("p",null,"HeadlessConfig"),(0,r.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/server/getSiteFromContext.ts#L10"},"packages/next/src/data/server/getSiteFromContext.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usepreparefetch"},"usePrepareFetch"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"usePrepareFetch"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"_params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Prepares params and options for useFetch hooks"),(0,r.kt)("h4",{id:"type-parameters-15"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Entity")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Entity"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"EndpointParams"))))),(0,r.kt)("h4",{id:"parameters-20"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"_params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The fetch params")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The fetch options")))),(0,r.kt)("h4",{id:"returns-21"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/hooks/usePrepareFetch.ts#L13"},"packages/next/src/data/hooks/usePrepareFetch.ts:13")),(0,r.kt)("h2",{id:"react-components"},"React Components"),(0,r.kt)("h3",{id:"headlessapp"},"HeadlessApp"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"HeadlessApp"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The HeadlessApp component is the top level component for the Headless framework."),(0,r.kt)("p",null,"Should be used in ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/_app.js")),(0,r.kt)("h2",{id:"usage-9"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},'import { HeadlessApp } from "@headstartwp/next";\n\nconst MyApp = ({ Component, pageProps }) => {\n const { fallback = {}, themeJson = {}, ...props } = pageProps;\n\n return (\n \n \n \n \n \n );\n};\n\nexport default MyApp;\n')),(0,r.kt)("h4",{id:"parameters-21"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#headlessappprops"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessAppProps"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component props. See ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#headlessappprops"},"HeadlessAppProps"))))),(0,r.kt)("h4",{id:"returns-22"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/components/HeadlessApp.tsx#L96"},"packages/next/src/components/HeadlessApp.tsx:96")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"imagecomponent"},"ImageComponent"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ImageComponent"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"An implementation of the ImageBlock (core/image)."),(0,r.kt)("p",null,"If ",(0,r.kt)("inlineCode",{parentName:"p"},"width"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"height")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"src")," are not provided, this component will not be used."),(0,r.kt)("h2",{id:"usage-10"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},'import { BlocksRenderer, ImageBlock } from "@headstartwp/core/react";\nimport { ImageComponent } from "@headstartwp/next";\n\n\n \n\n')),(0,r.kt)("h4",{id:"parameters-22"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_next.ImageProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ImageProps"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"ImageBlockProps")))),(0,r.kt)("h4",{id:"returns-23"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/components/ImageComponent.tsx#L98"},"packages/next/src/components/ImageComponent.tsx:98")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"linkblock"},"LinkBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"LinkBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The Link Block converts a anchor tag node into a next/link component if it's an internal link"),(0,r.kt)("h2",{id:"usage-11"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},'import { BlocksRenderer } from "@headstartwp/core/react";\nimport { LinkBlock } from "@headstartwp/next";\n\n\n \n\n')),(0,r.kt)("h4",{id:"parameters-23"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Omit"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"IBlock"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_next.LinkBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"LinkBlockProps")),">",", ",(0,r.kt)("inlineCode",{parentName:"td"},'"component"'),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Link Block Props")))),(0,r.kt)("h4",{id:"returns-24"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The next/link component"),(0,r.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/blocks/LinkBlock.tsx#L33"},"packages/next/src/blocks/LinkBlock.tsx:33")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"twitterblock"},"TwitterBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"TwitterBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"Renders a twitter embed"),(0,r.kt)("h2",{id:"usage-12"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},'import { BlocksRenderer } from "@headstartwp/core/react";\nimport { TwitterBlock } from "@headstartwp/next";\n\n\n \n\n')),(0,r.kt)("h4",{id:"parameters-24"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Omit"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"IBlock"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"IBlockAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"td"},'"component"'),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Link Block Props")))),(0,r.kt)("h4",{id:"returns-25"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/blocks/TwitterBlock.tsx#L25"},"packages/next/src/blocks/TwitterBlock.tsx:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast"},"Yoast"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"Yoast"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The Yoast component renders the Yoast SEO meta tags.\nThis component is automatically rendered by ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#headlessapp"},"HeadlessApp")," so you don't have to manually render it."),(0,r.kt)("h4",{id:"parameters-25"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Props")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component props. Expects a single ",(0,r.kt)("inlineCode",{parentName:"td"},"seo")," prop")))),(0,r.kt)("h4",{id:"returns-26"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/components/Yoast.tsx#L61"},"packages/next/src/components/Yoast.tsx:61")))}k.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3126],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>u});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var d=n.createContext({}),o=function(e){var t=n.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},s=function(e){var t=o(e.components);return n.createElement(d.Provider,{value:t},e.children)},k="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},N=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,d=e.parentName,s=i(e,["components","mdxType","originalType","parentName"]),k=o(a),N=r,u=k["".concat(d,".").concat(N)]||k[N]||m[N]||l;return a?n.createElement(u,p(p({ref:t},s),{},{components:a})):n.createElement(u,p({ref:t},s))}));function u(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,p=new Array(l);p[0]=N;var i={};for(var d in t)hasOwnProperty.call(t,d)&&(i[d]=t[d]);i.originalType=e,i[k]="string"==typeof e?e:r,p[1]=i;for(var o=2;o{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>k,frontMatter:()=>l,metadata:()=>i,toc:()=>o});var n=a(7462),r=(a(7294),a(3905));const l={id:"headstartwp_next",title:"Module: @headstartwp/next",sidebar_label:"@headstartwp/next",sidebar_position:0,custom_edit_url:null},p=void 0,i={unversionedId:"modules/headstartwp_next",id:"modules/headstartwp_next",title:"Module: @headstartwp/next",description:"Namespaces",source:"@site/docs/modules/headstartwp_next.md",sourceDirName:"modules",slug:"/modules/headstartwp_next",permalink:"/docs/api/modules/headstartwp_next",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"headstartwp_next",title:"Module: @headstartwp/next",sidebar_label:"@headstartwp/next",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core",permalink:"/docs/api/modules/headstartwp_core"},next:{title:"@headstartwp/core.react",permalink:"/docs/api/namespaces/headstartwp_core.react"}},d={},o=[{value:"Namespaces",id:"namespaces",level:2},{value:"Interfaces",id:"interfaces",level:2},{value:"API handlers",id:"api-handlers",level:2},{value:"previewHandler",id:"previewhandler",level:3},{value:"Usage",id:"usage",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"revalidateHandler",id:"revalidatehandler",level:3},{value:"Usage",id:"usage-1",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"Data Fetching Hooks",id:"data-fetching-hooks",level:2},{value:"useAppSettings",id:"useappsettings",level:3},{value:"Usage",id:"usage-2",level:2},{value:"Server-Side-Rendering or Static-Site-Generation",id:"server-side-rendering-or-static-site-generation",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"useAuthorArchive",id:"useauthorarchive",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"useMenu",id:"usemenu",level:3},{value:"Usage",id:"usage-3",level:2},{value:"Basic usage",id:"basic-usage",level:3},{value:"Re-fetching client-side on focus and/or mount",id:"re-fetching-client-side-on-focus-andor-mount",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"usePost",id:"usepost",level:3},{value:"Type parameters",id:"type-parameters-2",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"usePostOrPosts",id:"usepostorposts",level:3},{value:"Type parameters",id:"type-parameters-3",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"usePosts",id:"useposts",level:3},{value:"Handling multiple WordPress routes in a single next.js route",id:"handling-multiple-wordpress-routes-in-a-single-nextjs-route",level:3},{value:"Type parameters",id:"type-parameters-4",level:4},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"useSearch",id:"usesearch",level:3},{value:"Type parameters",id:"type-parameters-5",level:4},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"useSeo",id:"useseo",level:3},{value:"Usage",id:"usage-4",level:2},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"useTerms",id:"useterms",level:3},{value:"Usage",id:"usage-5",level:2},{value:"Type parameters",id:"type-parameters-6",level:4},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"Next.js Data Fetching Utilities",id:"nextjs-data-fetching-utilities",level:2},{value:"addHookData",id:"addhookdata",level:3},{value:"Usage",id:"usage-6",level:2},{value:"Type parameters",id:"type-parameters-7",level:4},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"convertToPath",id:"converttopath",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"fetchHookData",id:"fetchhookdata",level:3},{value:"Usage",id:"usage-7",level:2},{value:"Type parameters",id:"type-parameters-8",level:4},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"handleError",id:"handleerror",level:3},{value:"Usage",id:"usage-8",level:2},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"Other",id:"other",level:2},{value:"HeadlessAppProps",id:"headlessappprops",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"HeadlessGetServerSideProps",id:"headlessgetserversideprops",level:3},{value:"Type parameters",id:"type-parameters-9",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"HeadlessGetServerSidePropsContext",id:"headlessgetserversidepropscontext",level:3},{value:"Type parameters",id:"type-parameters-10",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"HeadlessGetStaticProps",id:"headlessgetstaticprops",level:3},{value:"Type parameters",id:"type-parameters-11",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"HeadlessGetStaticPropsPropsContext",id:"headlessgetstaticpropspropscontext",level:3},{value:"Type parameters",id:"type-parameters-12",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"HookState",id:"hookstate",level:3},{value:"Type parameters",id:"type-parameters-13",level:4},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"NextJSProps",id:"nextjsprops",level:3},{value:"Type parameters",id:"type-parameters-14",level:4},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"PreviewData",id:"previewdata",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"PreviewHandlerOptions",id:"previewhandleroptions",level:3},{value:"Type declaration",id:"type-declaration-4",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"VIPCustomImageLoader",id:"vipcustomimageloader",level:3},{value:"Defined in",id:"defined-in-26",level:4},{value:"seoKey",id:"seokey",level:3},{value:"Defined in",id:"defined-in-27",level:4},{value:"VIPImageLoader",id:"vipimageloader",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"convertUrl",id:"converturl",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"getPathName",id:"getpathname",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"getSiteFromContext",id:"getsitefromcontext",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Defined in",id:"defined-in-31",level:4},{value:"usePrepareFetch",id:"usepreparefetch",level:3},{value:"Type parameters",id:"type-parameters-15",level:4},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Defined in",id:"defined-in-32",level:4},{value:"React Components",id:"react-components",level:2},{value:"HeadlessApp",id:"headlessapp",level:3},{value:"Usage",id:"usage-9",level:2},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-22",level:4},{value:"Defined in",id:"defined-in-33",level:4},{value:"ImageComponent",id:"imagecomponent",level:3},{value:"Usage",id:"usage-10",level:2},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Defined in",id:"defined-in-34",level:4},{value:"LinkBlock",id:"linkblock",level:3},{value:"Usage",id:"usage-11",level:2},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-24",level:4},{value:"Defined in",id:"defined-in-35",level:4},{value:"TwitterBlock",id:"twitterblock",level:3},{value:"Usage",id:"usage-12",level:2},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Defined in",id:"defined-in-36",level:4},{value:"Yoast",id:"yoast",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-26",level:4},{value:"Defined in",id:"defined-in-37",level:4}],s={toc:o};function k(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"namespaces"},"Namespaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/namespaces/headstartwp_next.config"},"config")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/namespaces/headstartwp_next.middlewares"},"middlewares"))),(0,r.kt)("h2",{id:"interfaces"},"Interfaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions"},"FetchHookDataOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_next.ImageProps"},"ImageProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_next.LinkBlockProps"},"LinkBlockProps"))),(0,r.kt)("h2",{id:"api-handlers"},"API handlers"),(0,r.kt)("h3",{id:"previewhandler"},"previewHandler"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"previewHandler"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"req"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"res"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"The PreviewHandler is responsible for handling preview requests."),(0,r.kt)("p",null,"Handling Previews requires the Headless WordPress Plugin."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Important"),": This function is meant to be used in a api route at ",(0,r.kt)("inlineCode",{parentName:"p"},"/pages/api/preview"),"."),(0,r.kt)("h3",{id:"usage"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"// pages/api/preview.js\nimport { previewHandler } from '@headstartwp/next';\n\nexport default async function handler(req, res) {\n return previewHandler(req, res);\n}\n")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"req")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextApiRequest")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The request object,")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"res")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextApiResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The response object.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewhandleroptions"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewHandlerOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The PreviewHandlerOptions ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewhandleroptions"},"PreviewHandlerOptions"))))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"A response object."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/handlers/previewHandler.ts#L120"},"packages/next/src/handlers/previewHandler.ts:120")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"revalidatehandler"},"revalidateHandler"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"revalidateHandler"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"req"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"res"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"The RevalidateHandler is responsible for handling revalidate requests."),(0,r.kt)("p",null,"Handling revalidate requires the Headless WordPress Plugin."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Important"),": This function is meant to be used in a api route e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"/pages/api/revalidate"),"."),(0,r.kt)("h3",{id:"usage-1"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"// pages/api/revalidate.js\nimport { revalidateHandler } from '@headstartwp/next';\n\nexport default async function handler(req, res) {\n return revalidateHandler(req, res);\n}\n")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"req")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextApiRequest")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The request object,")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"res")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextApiResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The response object.")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"A response object."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/handlers/revalidateHandler.ts#L30"},"packages/next/src/handlers/revalidateHandler.ts:30")),(0,r.kt)("h2",{id:"data-fetching-hooks"},"Data Fetching Hooks"),(0,r.kt)("h3",{id:"useappsettings"},"useAppSettings"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useAppSettings"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettingsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useAppSettings hook"),(0,r.kt)("h2",{id:"usage-2"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"const { data, loading, error } = useAppSettings();\n\n// check loading and error states\n")),(0,r.kt)("h3",{id:"server-side-rendering-or-static-site-generation"},"Server-Side-Rendering or Static-Site-Generation"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"export async function getServerSideProps(context) {\n const useAppSettingsData = await fetchHookData(useAppSettings.fetcher(), context);\n return addHookData([useAppSettingsData], {});\n}\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Important"),": You most likely want to fetch app settings on every route so\nthat you can access global settings and menus in your pages & components"),(0,r.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"AppEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"AppEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"EndpointParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"EndpointParams"))))),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettingsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/hooks/useAppSettings.ts#L33"},"packages/next/src/data/hooks/useAppSettings.ts:33")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useauthorarchive"},"useAuthorArchive"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useAuthorArchive"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useAuthorArchive hook. Returns a collection of post entities queried by author"),(0,r.kt)("p",null,"This hook must be used with a catch-all route ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," (e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/author/[...path].js"),")"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Important"),": Use a catch-all and not an optional catch-all route (",(0,r.kt)("inlineCode",{parentName:"p"},"[[...path]].js"),") as the author param in the url is required."),(0,r.kt)("p",null,"In order to automatically map URL params create a catch-all route named ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js"),".\nYou can create the catch-all at any level e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/author/[...path].js"),", etc."),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/author/[...path].js")," route for instance would yield a URL like this: ",(0,r.kt)("inlineCode",{parentName:"p"},"/author-name/page/2"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"/author-name/category/category-name/page/3"),", etc."),(0,r.kt)("p",null,"The following URL params are supported:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Category (/author-name/category/category-name)"),(0,r.kt)("li",{parentName:"ul"},"Tag (/author-name/tag/tag-name)"),(0,r.kt)("li",{parentName:"ul"},"Author (/author/author-name)"),(0,r.kt)("li",{parentName:"ul"},"Pagination (/page/2)"),(0,r.kt)("li",{parentName:"ul"},"Custom Taxonomy (/author//taxonomy/term-name)")),(0,r.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams"))))),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"usePostsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/hooks/useAuthorArchive.ts#L29"},"packages/next/src/data/hooks/useAuthorArchive.ts:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usemenu"},"useMenu"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useMenu"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"menuLocation"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"useMenuResponse")),(0,r.kt)("p",null,"The useMenu hooks. Returns a Menu object."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Important"),": This hook depends on ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#useappsettings"},"useAppSettings"),". If you want to enable SSR;SSG for\nthis hook you will need to fetch app settings on the server side."),(0,r.kt)("h2",{id:"usage-3"},"Usage"),(0,r.kt)("h3",{id:"basic-usage"},"Basic usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"export const Nav = () => {\n const { data, loading, error } = useMenu('primary-menu');\n\n // handle loading, error states\n\n return ;\n}\n")),(0,r.kt)("h3",{id:"re-fetching-client-side-on-focus-andor-mount"},"Re-fetching client-side on focus and/or mount"),(0,r.kt)("p",null,"If you are fetching app settings on the server, you can enable re-fetching on focus and/or mount\nto ensure menus are always up-to date even when using SSG/ISR."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"export const Nav = () => {\n const { data, loading, error } = useMenu('primary-menu', {\n revalidateOnFocus: true,\n revalidateOnMount: true,\n });\n\n // handle loading, error states\n\n return ;\n}\n")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"menuLocation")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The slug of the menu location you want to fetch")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"AppEntity"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"SWR configuration options")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"useMenuResponse")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/hooks/useMenu.ts#L46"},"packages/next/src/data/hooks/useMenu.ts:46")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usepost"},"usePost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"usePost"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The usePost hook. Returns a single post entity"),(0,r.kt)("p",null,"In order to automatically map URL params create a catch-all route named ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js"),".\nYou can create the catch-all at any level e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/[...path].js"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/blog/[...path].js"),", etc."),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/[...path].js")," route for instance would yield a URL like this: ",(0,r.kt)("inlineCode",{parentName:"p"},"/post-slug"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"/2020/01/01/post-slug"),", etc."),(0,r.kt)("h4",{id:"type-parameters-2"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostParams"))))),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"usePostResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/hooks/usePost.ts#L18"},"packages/next/src/data/hooks/usePost.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usepostorposts"},"usePostOrPosts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"usePostOrPosts"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostOrPostResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The usePostOrPosts hook"),(0,r.kt)("h4",{id:"type-parameters-3"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostOrPostsParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostOrPostsParams"))))),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PostOrPostsFetchStrategyResult"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"usePostOrPostResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/hooks/usePostOrPosts.ts#L18"},"packages/next/src/data/hooks/usePostOrPosts.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useposts"},"usePosts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"usePosts"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The usePost hook. Returns a collection of post entities"),(0,r.kt)("p",null,"In order to automatically map URL params create a catch-all route named ",(0,r.kt)("inlineCode",{parentName:"p"},"[[...path]].js"),".\nYou can create the catch-all at any level e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/[[...path]].js"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/blog/[[...path]].js"),", etc."),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/blog/[[...path]].js")," route for instance would yield a URL like this: ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog/page/2"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog/category/category-name/page/3"),", etc."),(0,r.kt)("p",null,"The following URL params are supported:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Category (/category/category-name)"),(0,r.kt)("li",{parentName:"ul"},"Tag (/tag/tag-name)"),(0,r.kt)("li",{parentName:"ul"},"Author (/author/author-name)"),(0,r.kt)("li",{parentName:"ul"},"Pagination (/page/2)"),(0,r.kt)("li",{parentName:"ul"},"Date (/YYYY/MM/DD)"),(0,r.kt)("li",{parentName:"ul"},"Custom Taxonomy (/taxonomy/term-name)")),(0,r.kt)("h3",{id:"handling-multiple-wordpress-routes-in-a-single-nextjs-route"},"Handling multiple WordPress routes in a single next.js route"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," hook is very flexible and can handle multiple WordPress routes in a single next.js route when using the optional-catch-all route (",(0,r.kt)("inlineCode",{parentName:"p"},"[[...path]].js"),").\nAlongside with the actual data, ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," also returns information about the current route so you can conditionally load different components."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"const params = { postType: 'post' };\nconst Posts = () => {\n const { data, pageType } = usePosts(params);\n\n if (pageType.isAuthorArchive) {\n return \n }\n\n if (pageType.isCategoryArchive) {\n return \n }\n\n if (pageType.isTaxonomyArchive && pageType.taxonomy === 'my-custom-taxonomy' ) {\n return \n }\n\n return (\n
\n
    \n {data.posts.map((post) => (\n
  • \n {post.title.rendered}\n
  • \n ))}\n
\n
\n );\n};\n")),(0,r.kt)("h4",{id:"type-parameters-4"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams"))))),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"usePostsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/hooks/usePosts.ts#L62"},"packages/next/src/data/hooks/usePosts.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usesearch"},"useSearch"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSearch"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"useSearchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useSearch hook. Returns a collection of search entities"),(0,r.kt)("p",null,"In order to automatically map URL params create a catch-all route named ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js"),".\nYou can create the catch-all at any level e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/search/[[...path]].js")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/search/[[...path]].js")," route for instance would yield a URL like this: ",(0,r.kt)("inlineCode",{parentName:"p"},"/search/[term]/page/[number]"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"/search/[term]")," etc"),(0,r.kt)("h4",{id:"type-parameters-5"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams"))))),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"useSearchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/hooks/useSearch.ts#L18"},"packages/next/src/data/hooks/useSearch.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useseo"},"useSeo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSeo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"format"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("p",null,"The useSeo hook. Returns the current SEO object"),(0,r.kt)("h2",{id:"usage-4"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"const seo = useSeo();\n")),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"format")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},'"json"')),(0,r.kt)("td",{parentName:"tr",align:"left"},"how to return the seo object. Defaults to 'json'")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/hooks/useSeo.ts#L18"},"packages/next/src/data/hooks/useSeo.ts:18")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSeo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"format"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"format")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},'"html"'))))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/hooks/useSeo.ts#L19"},"packages/next/src/data/hooks/useSeo.ts:19")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSeo"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/hooks/useSeo.ts#L20"},"packages/next/src/data/hooks/useSeo.ts:20")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useterms"},"useTerms"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useTerms"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"useTermsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useTerms hook. Returns a collection of term entities"),(0,r.kt)("h2",{id:"usage-5"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"const { loading, data } = useTerms({ taxonomy: 'category', slug: 'cat-name' });\n")),(0,r.kt)("h4",{id:"type-parameters-6"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"TermEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"TermEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"TaxonomyArchiveParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"TaxonomyArchiveParams"))))),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"useTermsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/hooks/useTerms.ts#L19"},"packages/next/src/data/hooks/useTerms.ts:19")),(0,r.kt)("h2",{id:"nextjs-data-fetching-utilities"},"Next.js Data Fetching Utilities"),(0,r.kt)("h3",{id:"addhookdata"},"addHookData"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addHookData"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"_hookStates"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"nextProps"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"addHookData")," function is responsible for collecting all of the results from the ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData")," function calls\nand prepares the shape of the data to match what the frameworks expects (such as setting initial values for SWR and collecting SEO data)."),(0,r.kt)("h2",{id:"usage-6"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"export async function getServerSideProps(context) {\n try {\n const usePostsHook = await fetchHookData(usePosts.fetcher(),context);\n const useAppSettingsHook = await fetchHookData(useAppSettings.fetcher(),context);\n return addHookData([usePostsHook, useAppSettingsHook], {});\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("h4",{id:"type-parameters-7"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"[key: string]"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"; }")))),(0,r.kt)("h4",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"_hookStates")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#hookstate"},(0,r.kt)("inlineCode",{parentName:"a"},"HookState")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Entity")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Entity"),"[]",">",">","[]"),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nextProps")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#nextjsprops"},(0,r.kt)("inlineCode",{parentName:"a"},"NextJSProps")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Any additional props to pass to Next.js page routes.")))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"notFound?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"fallback"),": {} ; ",(0,r.kt)("inlineCode",{parentName:"td"},"seo"),": { ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," = seo; ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head_json"),": {} = seo","_","json } ; ",(0,r.kt)("inlineCode",{parentName:"td"},"themeJSON"),": {} }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props.fallback")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{}")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props.seo")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," = seo; ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head_json"),": {} = seo","_","json }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props.seo.yoast_head")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props.seo.yoast_head_json")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{}")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props.themeJSON")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{}")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirect?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Redirect"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"revalidate?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/server/addHookData.ts#L59"},"packages/next/src/data/server/addHookData.ts:59")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"converttopath"},"convertToPath"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"convertToPath"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"args"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Creates a path from array of arguments"),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Array of catch-all arguments")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/convertToPath.ts#L8"},"packages/next/src/data/convertToPath.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchhookdata"},"fetchHookData"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchHookData"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"R"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"fetchStrategy"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"additionalCacheObjects"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"data"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"R"),">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"isMainQuery"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,r.kt)("p",null,"A function that implements data fetching on the server. This should be used in ",(0,r.kt)("inlineCode",{parentName:"p"},"getServerSideProps"),"\nor ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps"),"."),(0,r.kt)("p",null,"Data fetching will be performed by the specified strategy and URL params will be automatically extracted\nfrom `context"),(0,r.kt)("h2",{id:"usage-7"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"export async function getServerSideProps(context) {\n try {\n const usePostsHook = await fetchHookData(usePosts.fetcher(),context);\n\n return addHookData([usePostsHook], {});\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("p",null,"@param fetchStrategy The fetch strategy to use. Typically this is exposed by the hook e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts.fetcher()"),"\n@param ctx The Next.js context, either the one from ",(0,r.kt)("inlineCode",{parentName:"p"},"getServerSideProps")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps"),"\n@param options See {@link FetchHookDataOptions}"),(0,r.kt)("p",null,"@returns An object with a key of ",(0,r.kt)("inlineCode",{parentName:"p"},"data")," and a value of the fetched data."),(0,r.kt)("h4",{id:"type-parameters-8"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"unknown"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"EndpointParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"EndpointParams"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"R")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))))),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetchStrategy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AbstractFetchStrategy"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"R"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ctx")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"GetServerSidePropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"GetStaticPropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookDataOptions")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"additionalCacheObjects"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"data"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"R"),">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"isMainQuery"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/server/fetchHookData.ts#L81"},"packages/next/src/data/server/fetchHookData.ts:81")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"handleerror"},"handleError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"handleError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"rootRoute?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"GetServerSidePropsResult"),"<{}",">",">"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"handleError")," function is responsible for handling errors that occur during\ndata fetching in ",(0,r.kt)("inlineCode",{parentName:"p"},"getServerSideProps")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps"),"."),(0,r.kt)("p",null,"It also handles redirects if ",(0,r.kt)("inlineCode",{parentName:"p"},"redirectStrategy")," is set to ",(0,r.kt)("inlineCode",{parentName:"p"},"404")," in ",(0,r.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,r.kt)("p",null,"If ",(0,r.kt)("inlineCode",{parentName:"p"},"error")," is of type NotFoundError it will redirect to the 404 page. Otherwise it will\nreturn a server error (500) page"),(0,r.kt)("h2",{id:"usage-8"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"export async function getServerSideProps(context) {\n try {\n const usePostsHook = await fetchHookData(usePosts.fetcher(),context);\n return addHookData([usePostsHook], {});\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("h4",{id:"parameters-15"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The error object")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ctx")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#headlessgetserversidepropscontext"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessGetServerSidePropsContext")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"),">"," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#headlessgetstaticpropspropscontext"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessGetStaticPropsPropsContext")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Next.js context")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"rootRoute")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The root route (deprecated/unnecessary). This needs to be revisited")))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"GetServerSidePropsResult"),"<{}",">",">"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/server/handleError.ts#L61"},"packages/next/src/data/server/handleError.ts:61")),(0,r.kt)("h2",{id:"other"},"Other"),(0,r.kt)("h3",{id:"headlessappprops"},"HeadlessAppProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessAppProps"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The props supported by ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#headlessapp"},"HeadlessApp"),"."),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"children?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ReactNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"handleYoast?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If true, will automatically load yoast seo metadata into the head ",(0,r.kt)("strong",{parentName:"td"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))," true")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pageProps")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The page props from next.js. It should contain ",(0,r.kt)("inlineCode",{parentName:"td"},"fallback"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"themeJson")," and other props. Those props are added when using ",(0,r.kt)("inlineCode",{parentName:"td"},"fetchHookData")," and ",(0,r.kt)("inlineCode",{parentName:"td"},"addHookData")," ",(0,r.kt)("strong",{parentName:"td"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))," - ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#fetchhookdata"},"fetchHookData")," - ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#addhookdata"},"addHookData"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"settings")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SettingsContextProps")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Supported settings by the framework. Such as custom image component, custom link component etc. ",(0,r.kt)("strong",{parentName:"td"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))," SettingsContextProps")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"swrConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"DataFetchingProviderProps"),"[",(0,r.kt)("inlineCode",{parentName:"td"},'"swrConfig"'),"]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Pass any configuration to the SWR library. Globally. These settings can be overridden at the hook level.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"useYoastHtml?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If true, will make the Yoast component use the ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head")," raw html to populate meta tags instead of ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head_json"),". ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head")," is the default and preferable option.")))),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/components/HeadlessApp.tsx#L18"},"packages/next/src/components/HeadlessApp.tsx:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headlessgetserversideprops"},"HeadlessGetServerSideProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessGetServerSideProps"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"GetServerSideProps"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">"),(0,r.kt)("h4",{id:"type-parameters-9"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Object")," = { ",(0,r.kt)("inlineCode",{parentName:"td"},"[key: string]"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"; }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Q")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"))))),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/types.ts#L16"},"packages/next/src/data/types.ts:16")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headlessgetserversidepropscontext"},"HeadlessGetServerSidePropsContext"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessGetServerSidePropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"GetServerSidePropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">"),(0,r.kt)("h4",{id:"type-parameters-10"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Q")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"))))),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/types.ts#L10"},"packages/next/src/data/types.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headlessgetstaticprops"},"HeadlessGetStaticProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessGetStaticProps"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"GetStaticProps"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">"),(0,r.kt)("h4",{id:"type-parameters-11"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Object")," = { ",(0,r.kt)("inlineCode",{parentName:"td"},"[key: string]"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"; }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Q")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"))))),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/types.ts#L21"},"packages/next/src/data/types.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headlessgetstaticpropspropscontext"},"HeadlessGetStaticPropsPropsContext"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessGetStaticPropsPropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"GetStaticPropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">"),(0,r.kt)("h4",{id:"type-parameters-12"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Q")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"))))),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/types.ts#L13"},"packages/next/src/data/types.ts:13")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hookstate"},"HookState"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HookState"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-parameters-13"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))))),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"additionalCacheObjects?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#hookstate"},(0,r.kt)("inlineCode",{parentName:"a"},"HookState")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">","[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isMainQuery")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/server/addHookData.ts#L10"},"packages/next/src/data/server/addHookData.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"nextjsprops"},"NextJSProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"NextJSProps"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-parameters-14"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P"))))),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"notFound?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirect?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Redirect"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"revalidate?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/server/addHookData.ts#L17"},"packages/next/src/data/server/addHookData.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"previewdata"},"PreviewData"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"PreviewData"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The shape of the preview data that's stored in the preview data cookie"),(0,r.kt)("h4",{id:"index-signature"},"Index signature"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"authToken")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The auth token that should be used to fetch the data")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the resource")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"postType")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The post type")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"revision")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether the preview data is on a revision")))),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/handlers/types.ts#L4"},"packages/next/src/handlers/types.ts:4")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"previewhandleroptions"},"PreviewHandlerOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"PreviewHandlerOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The options supported by ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#previewhandler"},"previewHandler")),(0,r.kt)("h4",{id:"type-declaration-4"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"getRedirectPath?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"defaultRedirectPath"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"post"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"postTypeDef"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"CustomPostType"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onRedirect?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"req"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"NextApiRequest"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"res"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"NextApiResponse"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"previewData"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),", ",(0,r.kt)("inlineCode",{parentName:"td"},"defaultRedirect?"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewhandleroptions"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewHandlerOptions")),"[",(0,r.kt)("inlineCode",{parentName:"td"},'"onRedirect"'),"]",", ",(0,r.kt)("inlineCode",{parentName:"td"},"redirectpath?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"preparePreviewData?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"req"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"NextApiRequest"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"res"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"NextApiResponse"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"post"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"previewData"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),") => ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")))))),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/handlers/previewHandler.ts#L11"},"packages/next/src/handlers/previewHandler.ts:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"vipcustomimageloader"},"VIPCustomImageLoader"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"VIPCustomImageLoader"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ImageLoaderProps")," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"aspectRatio?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }"),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/components/ImageComponent.tsx#L30"},"packages/next/src/components/ImageComponent.tsx:30")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"seokey"},"seoKey"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"seoKey"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"@seo"')),(0,r.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/hooks/useSeo.ts#L3"},"packages/next/src/data/hooks/useSeo.ts:3")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"vipimageloader"},"VIPImageLoader"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"VIPImageLoader"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Custom Image loader for WordPress VIP leveraging Photon's API. This can't be made\na global loader because of the local loader used on the custom image component."),(0,r.kt)("h4",{id:"parameters-16"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#vipcustomimageloader"},(0,r.kt)("inlineCode",{parentName:"a"},"VIPCustomImageLoader"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The loader props")))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/components/ImageComponent.tsx#L42"},"packages/next/src/components/ImageComponent.tsx:42")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"converturl"},"convertUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"convertUrl"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"hostUrl"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-17"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hostUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/components/Yoast.tsx#L15"},"packages/next/src/components/Yoast.tsx:15")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getpathname"},"getPathName"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getPathName"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"resolvedUrl"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Extracts the path name out of the Next.js resolvedUrl"),(0,r.kt)("h4",{id:"parameters-18"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"resolvedUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The full resolved URL")))),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/server/handleError.ts#L23"},"packages/next/src/data/server/handleError.ts:23")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsitefromcontext"},"getSiteFromContext"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSiteFromContext"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"HeadlessConfig")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"customPostTypes"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"CustomPostTypes")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customTaxonomies"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"CustomTaxonomies")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"debug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"devMode?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"redirects?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"requests?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"hostUrl"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"integrations"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Integrations")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"redirectStrategy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"RedirectStrategy")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sites"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"HeadlessConfig"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"useWordPressPlugin"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }"),(0,r.kt)("p",null,"Get site using context"),(0,r.kt)("h4",{id:"parameters-19"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ctx")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"GetServerSidePropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"PreviewData"),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"GetStaticPropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"PreviewData"),">")))),(0,r.kt)("h4",{id:"returns-20"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"HeadlessConfig")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"customPostTypes"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"CustomPostTypes")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customTaxonomies"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"CustomTaxonomies")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"debug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"devMode?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"redirects?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"requests?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"hostUrl"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"integrations"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Integrations")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"redirectStrategy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"RedirectStrategy")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sites"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"HeadlessConfig"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"useWordPressPlugin"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }"),(0,r.kt)("p",null,"HeadlessConfig"),(0,r.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/server/getSiteFromContext.ts#L10"},"packages/next/src/data/server/getSiteFromContext.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usepreparefetch"},"usePrepareFetch"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"usePrepareFetch"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"_params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Prepares params and options for useFetch hooks"),(0,r.kt)("h4",{id:"type-parameters-15"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Entity")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Entity"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"EndpointParams"))))),(0,r.kt)("h4",{id:"parameters-20"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"_params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The fetch params")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The fetch options")))),(0,r.kt)("h4",{id:"returns-21"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/hooks/usePrepareFetch.ts#L13"},"packages/next/src/data/hooks/usePrepareFetch.ts:13")),(0,r.kt)("h2",{id:"react-components"},"React Components"),(0,r.kt)("h3",{id:"headlessapp"},"HeadlessApp"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"HeadlessApp"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The HeadlessApp component is the top level component for the Headless framework."),(0,r.kt)("p",null,"Should be used in ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/_app.js")),(0,r.kt)("h2",{id:"usage-9"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},'import { HeadlessApp } from "@headstartwp/next";\n\nconst MyApp = ({ Component, pageProps }) => {\n const { fallback = {}, themeJson = {}, ...props } = pageProps;\n\n return (\n \n \n \n \n \n );\n};\n\nexport default MyApp;\n')),(0,r.kt)("h4",{id:"parameters-21"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#headlessappprops"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessAppProps"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component props. See ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#headlessappprops"},"HeadlessAppProps"))))),(0,r.kt)("h4",{id:"returns-22"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/components/HeadlessApp.tsx#L96"},"packages/next/src/components/HeadlessApp.tsx:96")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"imagecomponent"},"ImageComponent"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ImageComponent"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"An implementation of the ImageBlock (core/image)."),(0,r.kt)("p",null,"If ",(0,r.kt)("inlineCode",{parentName:"p"},"width"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"height")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"src")," are not provided, this component will not be used."),(0,r.kt)("h2",{id:"usage-10"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},'import { BlocksRenderer, ImageBlock } from "@headstartwp/core/react";\nimport { ImageComponent } from "@headstartwp/next";\n\n\n \n\n')),(0,r.kt)("h4",{id:"parameters-22"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_next.ImageProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ImageProps"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"ImageBlockProps")))),(0,r.kt)("h4",{id:"returns-23"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/components/ImageComponent.tsx#L98"},"packages/next/src/components/ImageComponent.tsx:98")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"linkblock"},"LinkBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"LinkBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The Link Block converts a anchor tag node into a next/link component if it's an internal link"),(0,r.kt)("h2",{id:"usage-11"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},'import { BlocksRenderer } from "@headstartwp/core/react";\nimport { LinkBlock } from "@headstartwp/next";\n\n\n \n\n')),(0,r.kt)("h4",{id:"parameters-23"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Omit"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"IBlock"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_next.LinkBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"LinkBlockProps")),">",", ",(0,r.kt)("inlineCode",{parentName:"td"},'"component"'),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Link Block Props")))),(0,r.kt)("h4",{id:"returns-24"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The next/link component"),(0,r.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/blocks/LinkBlock.tsx#L33"},"packages/next/src/blocks/LinkBlock.tsx:33")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"twitterblock"},"TwitterBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"TwitterBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"Renders a twitter embed"),(0,r.kt)("h2",{id:"usage-12"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},'import { BlocksRenderer } from "@headstartwp/core/react";\nimport { TwitterBlock } from "@headstartwp/next";\n\n\n \n\n')),(0,r.kt)("h4",{id:"parameters-24"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Omit"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"IBlock"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"IBlockAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"td"},'"component"'),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Link Block Props")))),(0,r.kt)("h4",{id:"returns-25"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/blocks/TwitterBlock.tsx#L25"},"packages/next/src/blocks/TwitterBlock.tsx:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast"},"Yoast"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"Yoast"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The Yoast component renders the Yoast SEO meta tags.\nThis component is automatically rendered by ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#headlessapp"},"HeadlessApp")," so you don't have to manually render it."),(0,r.kt)("h4",{id:"parameters-25"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Props")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component props. Expects a single ",(0,r.kt)("inlineCode",{parentName:"td"},"seo")," prop")))),(0,r.kt)("h4",{id:"returns-26"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/components/Yoast.tsx#L61"},"packages/next/src/components/Yoast.tsx:61")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/46c017ad.f71f1c7c.js b/assets/js/46c017ad.76c046fa.js similarity index 98% rename from assets/js/46c017ad.f71f1c7c.js rename to assets/js/46c017ad.76c046fa.js index 341358883..70ccc67f0 100644 --- a/assets/js/46c017ad.f71f1c7c.js +++ b/assets/js/46c017ad.76c046fa.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2398],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>N});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function p(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var o=n.createContext({}),s=function(e){var t=n.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=s(e.components);return n.createElement(o.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},c=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,p=e.originalType,o=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=s(a),c=r,N=m["".concat(o,".").concat(c)]||m[c]||k[c]||p;return a?n.createElement(N,i(i({ref:t},d),{},{components:a})):n.createElement(N,i({ref:t},d))}));function N(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var p=a.length,i=new Array(p);i[0]=c;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l[m]="string"==typeof e?e:r,i[1]=l;for(var s=2;s{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>m,frontMatter:()=>p,metadata:()=>l,toc:()=>s});var n=a(7462),r=(a(7294),a(3905));const p={id:"headstartwp_core.react",title:"Namespace: react",sidebar_label:"@headstartwp/core.react",custom_edit_url:null},i=void 0,l={unversionedId:"namespaces/headstartwp_core.react",id:"namespaces/headstartwp_core.react",title:"Namespace: react",description:"@headstartwp/core.react",source:"@site/docs/namespaces/headstartwp_core.react.md",sourceDirName:"namespaces",slug:"/namespaces/headstartwp_core.react",permalink:"/docs/api/namespaces/headstartwp_core.react",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react",title:"Namespace: react",sidebar_label:"@headstartwp/core.react",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/next",permalink:"/docs/api/modules/headstartwp_next"},next:{title:"@headstartwp/next.config",permalink:"/docs/api/namespaces/headstartwp_next.config"}},o={},s=[{value:"@headstartwp/core/react",id:"headstartwpcorereact",level:2},{value:"Usage",id:"usage",level:3},{value:"Interfaces",id:"interfaces",level:2},{value:"Blocks",id:"blocks",level:2},{value:"AudioBlock",id:"audioblock",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"ButtonBlock",id:"buttonblock",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"ButtonsBlock",id:"buttonsblock",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"CodeBlock",id:"codeblock",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Data Fetching Hooks",id:"data-fetching-hooks",level:2},{value:"useFetch",id:"usefetch",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"useFetchAppSettings",id:"usefetchappsettings",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"useFetchMenu",id:"usefetchmenu",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"useFetchPosts",id:"usefetchposts",level:3},{value:"Type parameters",id:"type-parameters-2",level:4},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"useFetchSearch",id:"usefetchsearch",level:3},{value:"Type parameters",id:"type-parameters-3",level:4},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"useFetchTerms",id:"usefetchterms",level:3},{value:"Type parameters",id:"type-parameters-4",level:4},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Other",id:"other",level:2},{value:"Align",id:"align",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"Border",id:"border",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"DataFetchingProviderProps",id:"datafetchingproviderprops",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"ItemWrapper",id:"itemwrapper",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Parameters",id:"parameters-10",level:5},{value:"Returns",id:"returns-10",level:5},{value:"Defined in",id:"defined-in-13",level:4},{value:"ItemWrapperProps",id:"itemwrapperprops",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"LinkWrapper",id:"linkwrapper",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Parameters",id:"parameters-11",level:5},{value:"Returns",id:"returns-11",level:5},{value:"Defined in",id:"defined-in-15",level:4},{value:"LinkWrapperProps",id:"linkwrapperprops",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"MenuItemsProp",id:"menuitemsprop",level:3},{value:"Type declaration",id:"type-declaration-4",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"MenuWrapper",id:"menuwrapper",level:3},{value:"Type declaration",id:"type-declaration-5",level:4},{value:"Parameters",id:"parameters-12",level:5},{value:"Returns",id:"returns-12",level:5},{value:"Defined in",id:"defined-in-18",level:4},{value:"MenuWrapperProps",id:"menuwrapperprops",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"PageType",id:"pagetype",level:3},{value:"Type declaration",id:"type-declaration-6",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"SettingsColorPalette",id:"settingscolorpalette",level:3},{value:"Type declaration",id:"type-declaration-7",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"SettingsColorPreset",id:"settingscolorpreset",level:3},{value:"Type declaration",id:"type-declaration-8",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"SettingsContextProps",id:"settingscontextprops",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"SettingsDuotone",id:"settingsduotone",level:3},{value:"Type declaration",id:"type-declaration-9",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"SettingsDuotonePreset",id:"settingsduotonepreset",level:3},{value:"Type declaration",id:"type-declaration-10",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"SettingsGradient",id:"settingsgradient",level:3},{value:"Type declaration",id:"type-declaration-11",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"SettingsGradientPreset",id:"settingsgradientpreset",level:3},{value:"Type declaration",id:"type-declaration-12",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"SettingsPropertiesComplete",id:"settingspropertiescomplete",level:3},{value:"Defined in",id:"defined-in-28",level:4},{value:"Spacing",id:"spacing",level:3},{value:"Type declaration",id:"type-declaration-13",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"Style",id:"style",level:3},{value:"Type declaration",id:"type-declaration-14",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"StylesPropertiesAndElementsComplete",id:"stylespropertiesandelementscomplete",level:3},{value:"Defined in",id:"defined-in-31",level:4},{value:"StylesPropertiesComplete",id:"stylespropertiescomplete",level:3},{value:"Defined in",id:"defined-in-32",level:4},{value:"ThemeJSON",id:"themejson",level:3},{value:"Defined in",id:"defined-in-33",level:4},{value:"SettingsContext",id:"settingscontext",level:3},{value:"Defined in",id:"defined-in-34",level:4},{value:"ThemeSettingsContext",id:"themesettingscontext",level:3},{value:"Defined in",id:"defined-in-35",level:4},{value:"defaultElement",id:"defaultelement",level:3},{value:"Defined in",id:"defined-in-36",level:4},{value:"ColumnBlock",id:"columnblock",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-37",level:4},{value:"ColumnsBlock",id:"columnsblock",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-38",level:4},{value:"CoverBlock",id:"coverblock",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-39",level:4},{value:"DataFetchingProvider",id:"datafetchingprovider",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"DebugBlock",id:"debugblock",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"FileBlock",id:"fileblock",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Defined in",id:"defined-in-42",level:4},{value:"GroupBlock",id:"groupblock",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Defined in",id:"defined-in-43",level:4},{value:"HeadingBlock",id:"headingblock",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Defined in",id:"defined-in-44",level:4},{value:"ImageBlock",id:"imageblock",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Defined in",id:"defined-in-45",level:4},{value:"ListBlock",id:"listblock",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-22",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"MediaTextBlock",id:"mediatextblock",level:3},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"Menu",id:"menu",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-24",level:4},{value:"Defined in",id:"defined-in-48",level:4},{value:"MenuItems",id:"menuitems",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Defined in",id:"defined-in-49",level:4},{value:"ParagraphBlock",id:"paragraphblock",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-26",level:4},{value:"Defined in",id:"defined-in-50",level:4},{value:"PreformattedBlock",id:"preformattedblock",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-27",level:4},{value:"Defined in",id:"defined-in-51",level:4},{value:"PullQuoteBlock",id:"pullquoteblock",level:3},{value:"Parameters",id:"parameters-28",level:4},{value:"Returns",id:"returns-28",level:4},{value:"Defined in",id:"defined-in-52",level:4},{value:"QuoteBlock",id:"quoteblock",level:3},{value:"Parameters",id:"parameters-29",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Defined in",id:"defined-in-53",level:4},{value:"SeparatorBlock",id:"separatorblock",level:3},{value:"Parameters",id:"parameters-30",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Defined in",id:"defined-in-54",level:4},{value:"SettingsProvider",id:"settingsprovider",level:3},{value:"Parameters",id:"parameters-31",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Defined in",id:"defined-in-55",level:4},{value:"SpacerBlock",id:"spacerblock",level:3},{value:"Parameters",id:"parameters-32",level:4},{value:"Returns",id:"returns-32",level:4},{value:"Defined in",id:"defined-in-56",level:4},{value:"TableBlock",id:"tableblock",level:3},{value:"Parameters",id:"parameters-33",level:4},{value:"Returns",id:"returns-33",level:4},{value:"Defined in",id:"defined-in-57",level:4},{value:"ThemeSettingsProvider",id:"themesettingsprovider",level:3},{value:"Parameters",id:"parameters-34",level:4},{value:"Returns",id:"returns-34",level:4},{value:"Defined in",id:"defined-in-58",level:4},{value:"VerseBlock",id:"verseblock",level:3},{value:"Parameters",id:"parameters-35",level:4},{value:"Returns",id:"returns-35",level:4},{value:"Defined in",id:"defined-in-59",level:4},{value:"YoutubeLiteBlock",id:"youtubeliteblock",level:3},{value:"Parameters",id:"parameters-36",level:4},{value:"Returns",id:"returns-36",level:4},{value:"Defined in",id:"defined-in-60",level:4},{value:"getAlignStyle",id:"getalignstyle",level:3},{value:"Parameters",id:"parameters-37",level:4},{value:"Returns",id:"returns-37",level:4},{value:"Defined in",id:"defined-in-61",level:4},{value:"getBlockStyle",id:"getblockstyle",level:3},{value:"Parameters",id:"parameters-38",level:4},{value:"Returns",id:"returns-38",level:4},{value:"Defined in",id:"defined-in-62",level:4},{value:"getColorStyles",id:"getcolorstyles",level:3},{value:"Parameters",id:"parameters-39",level:4},{value:"Returns",id:"returns-39",level:4},{value:"Defined in",id:"defined-in-63",level:4},{value:"getInlineStyles",id:"getinlinestyles",level:3},{value:"Parameters",id:"parameters-40",level:4},{value:"Returns",id:"returns-40",level:4},{value:"Defined in",id:"defined-in-64",level:4},{value:"getTypographyStyles",id:"gettypographystyles",level:3},{value:"Parameters",id:"parameters-41",level:4},{value:"Returns",id:"returns-41",level:4},{value:"Defined in",id:"defined-in-65",level:4},{value:"getWidthStyles",id:"getwidthstyles",level:3},{value:"Parameters",id:"parameters-42",level:4},{value:"Returns",id:"returns-42",level:4},{value:"Defined in",id:"defined-in-66",level:4},{value:"parseSeo",id:"parseseo",level:3},{value:"Parameters",id:"parameters-43",level:4},{value:"Returns",id:"returns-43",level:4},{value:"Defined in",id:"defined-in-67",level:4},{value:"safeArraySpread",id:"safearrayspread",level:3},{value:"Parameters",id:"parameters-44",level:4},{value:"Returns",id:"returns-44",level:4},{value:"Defined in",id:"defined-in-68",level:4},{value:"serializeKey",id:"serializekey",level:3},{value:"Parameters",id:"parameters-45",level:4},{value:"Returns",id:"returns-45",level:4},{value:"Defined in",id:"defined-in-69",level:4},{value:"useBlock",id:"useblock",level:3},{value:"Type parameters",id:"type-parameters-5",level:4},{value:"Parameters",id:"parameters-46",level:4},{value:"Returns",id:"returns-46",level:4},{value:"Defined in",id:"defined-in-70",level:4},{value:"useBlockAlign",id:"useblockalign",level:3},{value:"Parameters",id:"parameters-47",level:4},{value:"Returns",id:"returns-47",level:4},{value:"Defined in",id:"defined-in-71",level:4},{value:"useBlockAttributes",id:"useblockattributes",level:3},{value:"Parameters",id:"parameters-48",level:4},{value:"Returns",id:"returns-48",level:4},{value:"Defined in",id:"defined-in-72",level:4},{value:"useBlockBorder",id:"useblockborder",level:3},{value:"Parameters",id:"parameters-49",level:4},{value:"Returns",id:"returns-49",level:4},{value:"Defined in",id:"defined-in-73",level:4},{value:"useBlockColors",id:"useblockcolors",level:3},{value:"Parameters",id:"parameters-50",level:4},{value:"Returns",id:"returns-50",level:4},{value:"Defined in",id:"defined-in-74",level:4},{value:"useBlockSpacing",id:"useblockspacing",level:3},{value:"Parameters",id:"parameters-51",level:4},{value:"Returns",id:"returns-51",level:4},{value:"Defined in",id:"defined-in-75",level:4},{value:"useBlockStyle",id:"useblockstyle",level:3},{value:"Parameters",id:"parameters-52",level:4},{value:"Returns",id:"returns-52",level:4},{value:"Defined in",id:"defined-in-76",level:4},{value:"useBlockTypography",id:"useblocktypography",level:3},{value:"Parameters",id:"parameters-53",level:4},{value:"Returns",id:"returns-53",level:4},{value:"Defined in",id:"defined-in-77",level:4},{value:"useBlockWidth",id:"useblockwidth",level:3},{value:"Parameters",id:"parameters-54",level:4},{value:"Returns",id:"returns-54",level:4},{value:"Defined in",id:"defined-in-78",level:4},{value:"useFetchAuthorArchive",id:"usefetchauthorarchive",level:3},{value:"Type parameters",id:"type-parameters-6",level:4},{value:"Parameters",id:"parameters-55",level:4},{value:"Returns",id:"returns-55",level:4},{value:"Defined in",id:"defined-in-79",level:4},{value:"useFetchPost",id:"usefetchpost",level:3},{value:"Type parameters",id:"type-parameters-7",level:4},{value:"Parameters",id:"parameters-56",level:4},{value:"Returns",id:"returns-56",level:4},{value:"Defined in",id:"defined-in-80",level:4},{value:"useFetchPostOrPosts",id:"usefetchpostorposts",level:3},{value:"Type parameters",id:"type-parameters-8",level:4},{value:"Parameters",id:"parameters-57",level:4},{value:"Returns",id:"returns-57",level:4},{value:"Defined in",id:"defined-in-81",level:4},{value:"useSWR",id:"useswr",level:3},{value:"Type parameters",id:"type-parameters-9",level:4},{value:"Parameters",id:"parameters-58",level:4},{value:"Returns",id:"returns-58",level:4},{value:"Defined in",id:"defined-in-82",level:4},{value:"Type parameters",id:"type-parameters-10",level:4},{value:"Parameters",id:"parameters-59",level:4},{value:"Returns",id:"returns-59",level:4},{value:"Defined in",id:"defined-in-83",level:4},{value:"Type parameters",id:"type-parameters-11",level:4},{value:"Parameters",id:"parameters-60",level:4},{value:"Returns",id:"returns-60",level:4},{value:"Defined in",id:"defined-in-84",level:4},{value:"Type parameters",id:"type-parameters-12",level:4},{value:"Parameters",id:"parameters-61",level:4},{value:"Returns",id:"returns-61",level:4},{value:"Defined in",id:"defined-in-85",level:4},{value:"Type parameters",id:"type-parameters-13",level:4},{value:"Parameters",id:"parameters-62",level:4},{value:"Returns",id:"returns-62",level:4},{value:"Defined in",id:"defined-in-86",level:4},{value:"Type parameters",id:"type-parameters-14",level:4},{value:"Parameters",id:"parameters-63",level:4},{value:"Returns",id:"returns-63",level:4},{value:"Defined in",id:"defined-in-87",level:4},{value:"Type parameters",id:"type-parameters-15",level:4},{value:"Parameters",id:"parameters-64",level:4},{value:"Returns",id:"returns-64",level:4},{value:"Defined in",id:"defined-in-88",level:4},{value:"Type parameters",id:"type-parameters-16",level:4},{value:"Parameters",id:"parameters-65",level:4},{value:"Returns",id:"returns-65",level:4},{value:"Defined in",id:"defined-in-89",level:4},{value:"useSWRConfig",id:"useswrconfig",level:3},{value:"Returns",id:"returns-66",level:4},{value:"Defined in",id:"defined-in-90",level:4},{value:"useSettings",id:"usesettings",level:3},{value:"Returns",id:"returns-67",level:4},{value:"Defined in",id:"defined-in-91",level:4},{value:"useThemeSetting",id:"usethemesetting",level:3},{value:"Parameters",id:"parameters-66",level:4},{value:"Returns",id:"returns-68",level:4},{value:"Defined in",id:"defined-in-92",level:4},{value:"useThemeSettings",id:"usethemesettings",level:3},{value:"Returns",id:"returns-69",level:4},{value:"Defined in",id:"defined-in-93",level:4},{value:"useThemeStyles",id:"usethemestyles",level:3},{value:"Returns",id:"returns-70",level:4},{value:"Defined in",id:"defined-in-94",level:4},{value:"React Components",id:"react-components",level:2},{value:"BlocksRenderer",id:"blocksrenderer",level:3},{value:"Usage",id:"usage-1",level:2},{value:"Usage with the test function",id:"usage-with-the-test-function",level:3},{value:"Usage with classList and tagName props",id:"usage-with-classlist-and-tagname-props",level:3},{value:"Parameters",id:"parameters-67",level:4},{value:"Returns",id:"returns-71",level:4},{value:"Defined in",id:"defined-in-95",level:4},{value:"HtmlDecoder",id:"htmldecoder",level:3},{value:"Usage",id:"usage-2",level:2},{value:"Parameters",id:"parameters-68",level:4},{value:"Returns",id:"returns-72",level:4},{value:"Defined in",id:"defined-in-96",level:4},{value:"SafeHtml",id:"safehtml",level:3},{value:"Usage",id:"usage-3",level:2},{value:"Parameters",id:"parameters-69",level:4},{value:"Returns",id:"returns-73",level:4},{value:"Defined in",id:"defined-in-97",level:4}],d={toc:s};function m(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".react"),(0,r.kt)("h2",{id:"headstartwpcorereact"},"@headstartwp/core/react"),(0,r.kt)("p",null,"The react export of the ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/core")," package."),(0,r.kt)("h3",{id:"usage"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},'import { BlocksRenderer } from "@headstartwp/core/react";\n')),(0,r.kt)("h2",{id:"interfaces"},"Interfaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},"AudioBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.BlockAttributes"},"BlockAttributes")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},"BlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.BlockRendererProps"},"BlockRendererProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},"ButtonBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},"ButtonsBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},"CodeBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},"ColumnBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},"ColumnsBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},"CoverBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},"FetchHookOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},"FileBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},"GroupBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.GutenbergBlockProps"},"GutenbergBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},"HeadingBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps"},"HtmlDecodeProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock"},"IAudioBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock"},"IButtonBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock"},"IButtonsBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock"},"ICodeBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock"},"IColumnBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock"},"IColumnsBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ICoverBlock"},"ICoverBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IDataWPBlock"},"IDataWPBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IFileBlock"},"IFileBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock"},"IGroupBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock"},"IHeadingBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"},"IImageBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IListBlock"},"IListBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock"},"IMediaTextBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock"},"IParagraphBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock"},"IPreformattedBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock"},"IPullQuoteBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock"},"IQuoteBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock"},"ISeparatorBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock"},"ISpacerBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ITableBlock"},"ITableBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock"},"IVerseBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock"},"IYoutubeLiteBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},"ImageBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},"ListBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},"MediaTextBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},"ParagraphBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},"PreformattedBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},"PullQuoteBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},"QuoteBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps"},"SafeHtmlProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"},"SeparatorBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},"SettingsCustomAdditionalProperties")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},"SettingsProperties")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},"SpacerBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete"},"StylesElementsPropertiesComplete")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},"StylesProperties")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},"TableBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},"Typography")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},"VerseBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.WpThemeJSON"},"WpThemeJSON")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},"YoutubeLiteBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"},"useAppSettingsResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.useFetchOptions"},"useFetchOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"},"useMenuResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"},"usePostOrPostResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"},"usePostResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},"usePostsResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"},"useSearchResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"},"useTermsResponse"))),(0,r.kt)("h2",{id:"blocks"},"Blocks"),(0,r.kt)("h3",{id:"audioblock"},"AudioBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"AudioBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The AudioBlock components implements block parsing for the Audio block."),(0,r.kt)("p",null,"This component must be used within a ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," component."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"\n \n\n")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IAudioBlock"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/AudioBlock.tsx#L58"},"packages/core/src/react/blocks/AudioBlock.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"buttonblock"},"ButtonBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ButtonBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The ButtonBlock component implements block parsing for the Button block."),(0,r.kt)("p",null,"This component must be used within a ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," component."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"\n \n\n")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IButtonBlock"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/ButtonBlock.tsx#L62"},"packages/core/src/react/blocks/ButtonBlock.tsx:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"buttonsblock"},"ButtonsBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ButtonsBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The ButtonsBlock component implements block parsing for the Buttons block."),(0,r.kt)("p",null,"This component must be used within a ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," component."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"\n \n\n")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IButtonsBlock"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/ButtonsBlock.tsx#L28"},"packages/core/src/react/blocks/ButtonsBlock.tsx:28")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"codeblock"},"CodeBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"CodeBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The CodeBlock component implements block parsing for the core/code block."),(0,r.kt)("p",null,"This component must be used within a ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," component."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"\n \n\n")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"ICodeBlock"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/CodeBlock.tsx#L32"},"packages/core/src/react/blocks/CodeBlock.tsx:32")),(0,r.kt)("h2",{id:"data-fetching-hooks"},"Data Fetching Hooks"),(0,r.kt)("h3",{id:"usefetch"},"useFetch"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetch"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"E"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Params"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"R"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchStrategy"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The use Fetch Hook is the foundation for most hooks in the headless framework. It is a wrapper around\n",(0,r.kt)("inlineCode",{parentName:"p"},"useSWR")," and provides a consistent API for fetching data from the API. It requires a fetch strategy which implements\nthe actual data fetching logic"),(0,r.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"E")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"E"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,r.kt)("inlineCode",{parentName:"a"},"EndpointParams")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"R")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"E"))))),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetchStrategy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,r.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"E"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Params"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The fetch strategy.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"R"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path of the url to get url params from.")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The returned data of the fetcher function.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The error object thrown by the fetcher function.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isLoading")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isMainQuery")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isValidating")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"mutate")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"KeyedMutator"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"R"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/useFetch.ts#L30"},"packages/core/src/react/hooks/useFetch.ts:30")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchappsettings"},"useFetchAppSettings"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchAppSettings"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useAppSettingsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useAppSettings hook"),(0,r.kt)("p",null,"See useAppSettings"),(0,r.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AppEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AppEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,r.kt)("inlineCode",{parentName:"a"},"EndpointParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,r.kt)("inlineCode",{parentName:"a"},"EndpointParams")))))),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useAppSettingsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/useFetchAppSettings.ts#L21"},"packages/core/src/react/hooks/useFetchAppSettings.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchmenu"},"useFetchMenu"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchMenu"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"menuLocation"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useMenuResponse"))),(0,r.kt)("p",null,"The useFetchMenu hooks. Returns a Menu object."),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"menuLocation")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The slug of the menu location you want to fetch")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AppEntity")),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"SWR configuration options")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useMenuResponse"))),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/useFetchMenu.ts#L50"},"packages/core/src/react/hooks/useFetchMenu.ts:50")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchposts"},"useFetchPosts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchPosts"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetcher?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useFetchPosts hook. Returns a collection of post entities"),(0,r.kt)("p",null,"See usePosts for usage instructions."),(0,r.kt)("h4",{id:"type-parameters-2"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path of the url to get url params from.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetcher")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveFetchStrategy")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The fetch strategy to use. If none is passed, the default one is used")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/useFetchPosts.ts#L79"},"packages/core/src/react/hooks/useFetchPosts.ts:79")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchsearch"},"useFetchSearch"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchSearch"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useSearchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useFetchSearch hook. Returns a collection of post entities"),(0,r.kt)("p",null,"See useSearch for usage instructions."),(0,r.kt)("h4",{id:"type-parameters-3"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path of the url to get url params from.")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useSearchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/useFetchSearch.ts#L32"},"packages/core/src/react/hooks/useFetchSearch.ts:32")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchterms"},"useFetchTerms"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchTerms"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useTermsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useFetchTerms hook. Returns a collection of term entities"),(0,r.kt)("p",null,"See useTerms for usage instructions."),(0,r.kt)("h4",{id:"type-parameters-4"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams")))))),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path of the url to get url params from.")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useTermsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/useFetchTerms.ts#L29"},"packages/core/src/react/hooks/useFetchTerms.ts:29")),(0,r.kt)("h2",{id:"other"},"Other"),(0,r.kt)("h3",{id:"align"},"Align"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Align"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"none"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"left"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"center"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"right"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"wide"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"full"')),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L15"},"packages/core/src/react/blocks/types.ts:15")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"border"},"Border"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Border"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"radius?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"width?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L65"},"packages/core/src/react/blocks/types.ts:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"datafetchingproviderprops"},"DataFetchingProviderProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"DataFetchingProviderProps"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRConfiguration"),"[",(0,r.kt)("inlineCode",{parentName:"td"},'"fallback"'),"]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"swrConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRConfiguration")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Pass any configuration to the SWR library. Globally. These settings can be overridden at the hook level.")))),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/DataFetchingProvider.tsx#L6"},"packages/core/src/react/provider/DataFetchingProvider.tsx:6")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"itemwrapper"},"ItemWrapper"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ItemWrapper"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#itemwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"ItemWrapperProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h5",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#itemwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"ItemWrapperProps")))))),(0,r.kt)("h5",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/Menu.tsx#L15"},"packages/core/src/react/components/Menu.tsx:15")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"itemwrapperprops"},"ItemWrapperProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ItemWrapperProps"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"PropsWithChildren"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"depth"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"item"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuItemEntity"))," }",">"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/Menu.tsx#L10"},"packages/core/src/react/components/Menu.tsx:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"linkwrapper"},"LinkWrapper"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"LinkWrapper"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#linkwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"LinkWrapperProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h5",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#linkwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"LinkWrapperProps")))))),(0,r.kt)("h5",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/Menu.tsx#L27"},"packages/core/src/react/components/Menu.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"linkwrapperprops"},"LinkWrapperProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"LinkWrapperProps"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"PropsWithChildren"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"depth"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"href"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/Menu.tsx#L23"},"packages/core/src/react/components/Menu.tsx:23")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menuitemsprop"},"MenuItemsProp"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"MenuItemsProp"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-4"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"depth")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"itemWrapper")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#itemwrapper"},(0,r.kt)("inlineCode",{parentName:"a"},"ItemWrapper")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"items")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuItemEntity")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"linkWrapper")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#linkwrapper"},(0,r.kt)("inlineCode",{parentName:"a"},"LinkWrapper")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"menuWrapper")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#menuwrapper"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuWrapper")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"topLevelItemsClickable")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/Menu.tsx#L29"},"packages/core/src/react/components/Menu.tsx:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menuwrapper"},"MenuWrapper"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"MenuWrapper"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#menuwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuWrapperProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"type-declaration-5"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h5",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#menuwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuWrapperProps")))))),(0,r.kt)("h5",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/Menu.tsx#L21"},"packages/core/src/react/components/Menu.tsx:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menuwrapperprops"},"MenuWrapperProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"MenuWrapperProps"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"PropsWithChildren"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"depth"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," }",">"),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/Menu.tsx#L17"},"packages/core/src/react/components/Menu.tsx:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"pagetype"},"PageType"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"PageType"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-6"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isAuthorArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Author Archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isCategoryArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Category Archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isPostArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Regular post archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isPostTypeArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Custom Post Type Archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isSearch")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Search route")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isTagArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Tag Archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isTaxonomyArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Custom Taxonomy Archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"postType")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Which post type this archive is for")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"taxonomy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Which taxonomy this archive is for")))),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/useFetchPosts.ts#L19"},"packages/core/src/react/hooks/useFetchPosts.ts:19")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingscolorpalette"},"SettingsColorPalette"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsColorPalette"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-7"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"theme?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"user?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPreset")),"[]")))),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L47"},"packages/core/src/react/provider/types.ts:47")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingscolorpreset"},"SettingsColorPreset"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsColorPreset"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-8"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"color")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"CSS hex or rgb(a) string.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Name of the color preset, translatable.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Kebab-case unique identifier for the color preset.")))),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L32"},"packages/core/src/react/provider/types.ts:32")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingscontextprops"},"SettingsContextProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsContextProps"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"imageComponent?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"React.FC"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IImageBlock")),">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"linkComponent?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")," } & ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L5"},"packages/core/src/react/provider/types.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingsduotone"},"SettingsDuotone"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsDuotone"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-9"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotonepreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotonePreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"theme?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotonepreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotonePreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"user?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotonepreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotonePreset")),"[]")))),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L89"},"packages/core/src/react/provider/types.ts:89")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingsduotonepreset"},"SettingsDuotonePreset"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsDuotonePreset"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-10"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"colors")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"List of colors from dark to light.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Name of the duotone preset, translatable.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Kebab-case unique identifier for the duotone preset.")))),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L74"},"packages/core/src/react/provider/types.ts:74")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingsgradient"},"SettingsGradient"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsGradient"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-11"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradientpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradientPreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"theme?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradientpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradientPreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"user?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradientpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradientPreset")),"[]")))),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L68"},"packages/core/src/react/provider/types.ts:68")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingsgradientpreset"},"SettingsGradientPreset"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsGradientPreset"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-12"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"gradient")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"CSS gradient string.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Name of the gradient preset, translatable.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Kebab-case unique identifier for the gradient preset.")))),(0,r.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L53"},"packages/core/src/react/provider/types.ts:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingspropertiescomplete"},"SettingsPropertiesComplete"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsPropertiesComplete"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"border"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"color"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"custom?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"custom"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"layout?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"layout"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"spacing"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"typography"'),"]"," }"),(0,r.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L10"},"packages/core/src/react/provider/types.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"spacing"},"Spacing"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Spacing"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-13"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockGap")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"bottom"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"left"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"right"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"top"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.bottom")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.left")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.right")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.top")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"bottom"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"left"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"right"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"top"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.bottom")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.left")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.right")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.top")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"supportsBlockGap")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"supportsMargin")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"supportsPadding")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L40"},"packages/core/src/react/blocks/types.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"Style"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-14"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"border")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,r.kt)("inlineCode",{parentName:"a"},"Border")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"spacing")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,r.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"typography")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,r.kt)("inlineCode",{parentName:"a"},"Typography")))))),(0,r.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L17"},"packages/core/src/react/blocks/types.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"stylespropertiesandelementscomplete"},"StylesPropertiesAndElementsComplete"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"StylesPropertiesAndElementsComplete"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"border"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"color"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"elements?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesElementsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"spacing"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"typography"'),"]"," }"),(0,r.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L24"},"packages/core/src/react/provider/types.ts:24")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"stylespropertiescomplete"},"StylesPropertiesComplete"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"StylesPropertiesComplete"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"border"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"color"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"spacing"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"typography"'),"]"," }"),(0,r.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L18"},"packages/core/src/react/provider/types.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"themejson"},"ThemeJSON"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ThemeJSON"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Pick"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.WpThemeJSON"},(0,r.kt)("inlineCode",{parentName:"a"},"WpThemeJSON")),", ",(0,r.kt)("inlineCode",{parentName:"p"},'"styles"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"settings"'),">"),(0,r.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L352"},"packages/core/src/react/provider/types.ts:352")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingscontext"},"SettingsContext"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"SettingsContext"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Context"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscontextprops"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsContextProps")),">",">"),(0,r.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/Provider.tsx#L5"},"packages/core/src/react/provider/Provider.tsx:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"themesettingscontext"},"ThemeSettingsContext"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"ThemeSettingsContext"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Context"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#themejson"},(0,r.kt)("inlineCode",{parentName:"a"},"ThemeJSON")),">"),(0,r.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/ThemeSettingsProvider.tsx#L4"},"packages/core/src/react/provider/ThemeSettingsProvider.tsx:4")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"defaultelement"},"defaultElement"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"defaultElement"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/hooks/useBlock.ts#L8"},"packages/core/src/react/blocks/hooks/useBlock.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"columnblock"},"ColumnBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ColumnBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IColumnBlock")))))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/ColumnBlock.tsx#L11"},"packages/core/src/react/blocks/ColumnBlock.tsx:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"columnsblock"},"ColumnsBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ColumnsBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IColumnsBlock")))))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/ColumnsBlocks.tsx#L11"},"packages/core/src/react/blocks/ColumnsBlocks.tsx:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"coverblock"},"CoverBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"CoverBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-15"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ICoverBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"ICoverBlock")))))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/CoverBlock.tsx#L24"},"packages/core/src/react/blocks/CoverBlock.tsx:24")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"datafetchingprovider"},"DataFetchingProvider"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"DataFetchingProvider"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"context?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"parameters-16"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#datafetchingproviderprops"},(0,r.kt)("inlineCode",{parentName:"a"},"DataFetchingProviderProps")),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"context?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/react/index.d.ts:542"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"debugblock"},"DebugBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"DebugBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-17"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object"))))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/DebugBlock.tsx#L7"},"packages/core/src/react/blocks/DebugBlock.tsx:7")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fileblock"},"FileBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"FileBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-18"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IFileBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IFileBlock")))))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/FileBlock.tsx#L14"},"packages/core/src/react/blocks/FileBlock.tsx:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"groupblock"},"GroupBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"GroupBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-19"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IGroupBlock")))))),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/GroupBlock.tsx#L17"},"packages/core/src/react/blocks/GroupBlock.tsx:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headingblock"},"HeadingBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"HeadingBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-20"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IHeadingBlock")))))),(0,r.kt)("h4",{id:"returns-20"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/HeadingBlock.tsx#L12"},"packages/core/src/react/blocks/HeadingBlock.tsx:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"imageblock"},"ImageBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ImageBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-21"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IImageBlock")))))),(0,r.kt)("h4",{id:"returns-21"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/ImageBlock.tsx#L19"},"packages/core/src/react/blocks/ImageBlock.tsx:19")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"listblock"},"ListBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ListBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-22"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IListBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IListBlock")))))),(0,r.kt)("h4",{id:"returns-22"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/ListBlock.tsx#L12"},"packages/core/src/react/blocks/ListBlock.tsx:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"mediatextblock"},"MediaTextBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"MediaTextBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-23"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IMediaTextBlock")))))),(0,r.kt)("h4",{id:"returns-23"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/MediaTextBlock.tsx#L22"},"packages/core/src/react/blocks/MediaTextBlock.tsx:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menu"},"Menu"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"Menu"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-24"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"MenuProps"))))),(0,r.kt)("h4",{id:"returns-24"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/Menu.tsx#L109"},"packages/core/src/react/components/Menu.tsx:109")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menuitems"},"MenuItems"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"MenuItems"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-25"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#menuitemsprop"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuItemsProp")))))),(0,r.kt)("h4",{id:"returns-25"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/Menu.tsx#L54"},"packages/core/src/react/components/Menu.tsx:54")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"paragraphblock"},"ParagraphBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ParagraphBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-26"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IParagraphBlock")))))),(0,r.kt)("h4",{id:"returns-26"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/ParagraphBlock.tsx#L13"},"packages/core/src/react/blocks/ParagraphBlock.tsx:13")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"preformattedblock"},"PreformattedBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"PreformattedBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-27"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IPreformattedBlock")))))),(0,r.kt)("h4",{id:"returns-27"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/PreformatedBlock.tsx#L11"},"packages/core/src/react/blocks/PreformatedBlock.tsx:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"pullquoteblock"},"PullQuoteBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"PullQuoteBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-28"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IPullQuoteBlock")))))),(0,r.kt)("h4",{id:"returns-28"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/PullQuote.tsx#L15"},"packages/core/src/react/blocks/PullQuote.tsx:15")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"quoteblock"},"QuoteBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"QuoteBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-29"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IQuoteBlock")))))),(0,r.kt)("h4",{id:"returns-29"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-53"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/QuoteBlock.tsx#L10"},"packages/core/src/react/blocks/QuoteBlock.tsx:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"separatorblock"},"SeparatorBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"SeparatorBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-30"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"ISeparatorBlock")))))),(0,r.kt)("h4",{id:"returns-30"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-54"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/SeparatorBlock.tsx#L10"},"packages/core/src/react/blocks/SeparatorBlock.tsx:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingsprovider"},"SettingsProvider"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"SettingsProvider"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"context?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"parameters-31"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ProviderProps"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"context?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns-31"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-55"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/react/index.d.ts:542"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"spacerblock"},"SpacerBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"SpacerBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-32"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"ISpacerBlock")))))),(0,r.kt)("h4",{id:"returns-32"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-56"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/SpacerBlock.tsx#L12"},"packages/core/src/react/blocks/SpacerBlock.tsx:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tableblock"},"TableBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"TableBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-33"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ITableBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"ITableBlock")))))),(0,r.kt)("h4",{id:"returns-33"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-57"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/TableBlock.tsx#L12"},"packages/core/src/react/blocks/TableBlock.tsx:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"themesettingsprovider"},"ThemeSettingsProvider"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ThemeSettingsProvider"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"context?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"parameters-34"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ProviderProps"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"context?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns-34"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-58"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/react/index.d.ts:542"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"verseblock"},"VerseBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"VerseBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-35"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IVerseBlock")))))),(0,r.kt)("h4",{id:"returns-35"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-59"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/VerseBlock.tsx#L11"},"packages/core/src/react/blocks/VerseBlock.tsx:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"youtubeliteblock"},"YoutubeLiteBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"YoutubeLiteBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"Renders Youtube embeds with lite-youtube-embed"),(0,r.kt)("h4",{id:"parameters-36"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Omit"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IYoutubeLiteBlock")),", ",(0,r.kt)("inlineCode",{parentName:"td"},'"component"'),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Block props")))),(0,r.kt)("h4",{id:"returns-36"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-60"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/YoutubeLiteBlock.tsx#L41"},"packages/core/src/react/blocks/YoutubeLiteBlock.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getalignstyle"},"getAlignStyle"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAlignStyle"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},'"none"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"left"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"center"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"right"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"wide"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"full"')),(0,r.kt)("h4",{id:"parameters-37"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))))),(0,r.kt)("h4",{id:"returns-37"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},'"none"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"left"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"center"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"right"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"wide"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"full"')),(0,r.kt)("h4",{id:"defined-in-61"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/utils.ts#L5"},"packages/core/src/react/blocks/utils.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getblockstyle"},"getBlockStyle"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getBlockStyle"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the block style (is-style-{block-style})"),(0,r.kt)("h4",{id:"parameters-38"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-38"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"string with block style"),(0,r.kt)("h4",{id:"defined-in-62"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/utils.ts#L39"},"packages/core/src/react/blocks/utils.ts:39")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcolorstyles"},"getColorStyles"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getColorStyles"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,r.kt)("inlineCode",{parentName:"a"},"Colors"))),(0,r.kt)("p",null,"Infer GB color styles from classnames"),(0,r.kt)("h4",{id:"parameters-39"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-39"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,r.kt)("inlineCode",{parentName:"a"},"Colors"))),(0,r.kt)("p",null,"ColorBlockProps object"),(0,r.kt)("h4",{id:"defined-in-63"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/utils.ts#L62"},"packages/core/src/react/blocks/utils.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getinlinestyles"},"getInlineStyles"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getInlineStyles"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Converts inline styles to a stylesObject for use in react components"),(0,r.kt)("h4",{id:"parameters-40"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-40"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-64"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/utils.ts#L120"},"packages/core/src/react/blocks/utils.ts:120")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"gettypographystyles"},"getTypographyStyles"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getTypographyStyles"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Returns the typography styles of a block"),(0,r.kt)("h4",{id:"parameters-41"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-41"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontSize")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"fontSize"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," = ''; ",(0,r.kt)("inlineCode",{parentName:"td"},"lineHeight"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," = '' }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style.fontSize")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style.lineHeight")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-65"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/utils.ts#L177"},"packages/core/src/react/blocks/utils.ts:177")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getwidthstyles"},"getWidthStyles"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getWidthStyles"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the width size of a block"),(0,r.kt)("h4",{id:"parameters-42"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-42"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-66"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/utils.ts#L149"},"packages/core/src/react/blocks/utils.ts:149")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parseseo"},"parseSeo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"parseSeo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"seo"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Element"),"[]"),(0,r.kt)("h4",{id:"parameters-43"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"seo")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"HTMLReactParserOptions")))))),(0,r.kt)("h4",{id:"returns-43"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Element"),"[]"),(0,r.kt)("h4",{id:"defined-in-67"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/utils/parseSeo.ts#L4"},"packages/core/src/react/utils/parseSeo.ts:4")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"safearrayspread"},"safeArraySpread"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"safeArraySpread"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"array"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"[]"),(0,r.kt)("h4",{id:"parameters-44"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"array")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns-44"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any"),"[]"),(0,r.kt)("h4",{id:"defined-in-68"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/utils.ts#L220"},"packages/core/src/react/blocks/utils.ts:220")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"serializekey"},"serializeKey"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"serializeKey"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-45"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Key"))))),(0,r.kt)("h4",{id:"returns-45"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-69"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/core/dist/index.d.ts:17"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblock"},"useBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlock"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"node?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Returns the block name and attributes"),(0,r.kt)("h4",{id:"type-parameters-5"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlockAttributes")))))),(0,r.kt)("h4",{id:"parameters-46"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-46"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"attributes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"className")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-70"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/hooks/useBlock.ts#L38"},"packages/core/src/react/blocks/hooks/useBlock.ts:38")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockalign"},"useBlockAlign"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockAlign"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,r.kt)("inlineCode",{parentName:"a"},"Align"))),(0,r.kt)("p",null,"Returns the block align style (if available)"),(0,r.kt)("h4",{id:"parameters-47"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-47"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,r.kt)("inlineCode",{parentName:"a"},"Align"))),(0,r.kt)("h4",{id:"defined-in-71"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/hooks/useBlockAlign.ts#L16"},"packages/core/src/react/blocks/hooks/useBlockAlign.ts:16")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockattributes"},"useBlockAttributes"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockAttributes"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"useBlockAttributes hooks returns the block attributes for a given block based on what it supports"),(0,r.kt)("h4",{id:"parameters-48"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The reference to the dom node of the block")))),(0,r.kt)("h4",{id:"returns-48"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"align")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,r.kt)("inlineCode",{parentName:"a"},"Align")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockStyle")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"border")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,r.kt)("inlineCode",{parentName:"a"},"Border")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"colors")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,r.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"spacing")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,r.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"typography")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,r.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"width")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-72"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/hooks/useBlockAttributes.ts#L19"},"packages/core/src/react/blocks/hooks/useBlockAttributes.ts:19")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockborder"},"useBlockBorder"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockBorder"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,r.kt)("inlineCode",{parentName:"a"},"Border"))),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-49"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-49"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,r.kt)("inlineCode",{parentName:"a"},"Border"))),(0,r.kt)("h4",{id:"defined-in-73"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/hooks/useBlockBorder.ts#L17"},"packages/core/src/react/blocks/hooks/useBlockBorder.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockcolors"},"useBlockColors"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockColors"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,r.kt)("inlineCode",{parentName:"a"},"Colors"))),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-50"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-50"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,r.kt)("inlineCode",{parentName:"a"},"Colors"))),(0,r.kt)("h4",{id:"defined-in-74"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/hooks/useBlockColors.ts#L25"},"packages/core/src/react/blocks/hooks/useBlockColors.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockspacing"},"useBlockSpacing"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockSpacing"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,r.kt)("inlineCode",{parentName:"a"},"Spacing"))),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-51"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-51"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,r.kt)("inlineCode",{parentName:"a"},"Spacing"))),(0,r.kt)("h4",{id:"defined-in-75"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/hooks/useBlockSpacing.ts#L21"},"packages/core/src/react/blocks/hooks/useBlockSpacing.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockstyle"},"useBlockStyle"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockStyle"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-52"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-52"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-76"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/hooks/useBlockStyle.ts#L10"},"packages/core/src/react/blocks/hooks/useBlockStyle.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblocktypography"},"useBlockTypography"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockTypography"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,r.kt)("inlineCode",{parentName:"a"},"Typography"))),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-53"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-53"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,r.kt)("inlineCode",{parentName:"a"},"Typography"))),(0,r.kt)("h4",{id:"defined-in-77"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/hooks/useBlockTypography.ts#L25"},"packages/core/src/react/blocks/hooks/useBlockTypography.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockwidth"},"useBlockWidth"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockWidth"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-54"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-54"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-78"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/hooks/useBlockWidth.ts#L16"},"packages/core/src/react/blocks/hooks/useBlockWidth.ts:16")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchauthorarchive"},"useFetchAuthorArchive"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchAuthorArchive"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useFetchAuthorArchive hook"),(0,r.kt)("p",null,"See useAuthorArchive"),(0,r.kt)("h4",{id:"type-parameters-6"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,r.kt)("h4",{id:"parameters-55"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path of the url to get url params from.")))),(0,r.kt)("h4",{id:"returns-55"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-79"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/useFetchAuthorArchive.ts#L22"},"packages/core/src/react/hooks/useFetchAuthorArchive.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchpost"},"useFetchPost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchPost"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"type-parameters-7"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostParams")))))),(0,r.kt)("h4",{id:"parameters-56"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''"))))),(0,r.kt)("h4",{id:"returns-56"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-80"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/useFetchPost.ts#L30"},"packages/core/src/react/hooks/useFetchPost.ts:30")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchpostorposts"},"useFetchPostOrPosts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchPostOrPosts"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostOrPostResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"type-parameters-8"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams")))))),(0,r.kt)("h4",{id:"parameters-57"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#postorpostsfetchstrategyresult"},(0,r.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategyResult")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''"))))),(0,r.kt)("h4",{id:"returns-57"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostOrPostResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-81"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/useFetchPostOrPosts.ts#L32"},"packages/core/src/react/hooks/useFetchPostOrPosts.ts:32")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useswr"},"useSWR"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRKey"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-9"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Key")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"StrictKey"))))),(0,r.kt)("h4",{id:"parameters-58"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"))))),(0,r.kt)("h4",{id:"returns-58"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-82"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:200"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRKey"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetcher"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-10"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Key")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"StrictKey"))))),(0,r.kt)("h4",{id:"parameters-59"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetcher")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">")))),(0,r.kt)("h4",{id:"returns-59"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-83"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:201"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRKey"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-11"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Key")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"StrictKey"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">",">",">"," = ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">",">",">")))),(0,r.kt)("h4",{id:"parameters-60"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions"))))),(0,r.kt)("h4",{id:"returns-60"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("h4",{id:"defined-in-84"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:202"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRKey"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetcher"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-12"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Key")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"StrictKey"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">",">",">"," = ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">",">",">")))),(0,r.kt)("h4",{id:"parameters-61"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetcher")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions"))))),(0,r.kt)("h4",{id:"returns-61"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("h4",{id:"defined-in-85"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:203"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-13"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"parameters-62"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Key"))))),(0,r.kt)("h4",{id:"returns-62"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-86"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:204"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetcher"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-14"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"parameters-63"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Key"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetcher")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">")))),(0,r.kt)("h4",{id:"returns-63"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-87"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:205"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-15"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">",">",">"," = ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">",">",">")))),(0,r.kt)("h4",{id:"parameters-64"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Key"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions"))))),(0,r.kt)("h4",{id:"returns-64"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("h4",{id:"defined-in-88"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:206"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetcher"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-16"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">",">",">"," = ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">",">",">")))),(0,r.kt)("h4",{id:"parameters-65"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Key"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetcher")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions"))))),(0,r.kt)("h4",{id:"returns-65"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("h4",{id:"defined-in-89"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:207"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useswrconfig"},"useSWRConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWRConfig"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"FullConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">",">"),(0,r.kt)("h4",{id:"returns-66"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"FullConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">",">"),(0,r.kt)("h4",{id:"defined-in-90"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:336"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usesettings"},"useSettings"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSettings"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscontextprops"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsContextProps")),">"),(0,r.kt)("h4",{id:"returns-67"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscontextprops"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsContextProps")),">"),(0,r.kt)("h4",{id:"defined-in-91"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/useSettings.ts#L4"},"packages/core/src/react/provider/useSettings.ts:4")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usethemesetting"},"useThemeSetting"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useThemeSetting"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"blockName?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultValue?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fallbackToGlobalSetting?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("p",null,"Returns a single theme setting normalized"),(0,r.kt)("h4",{id:"parameters-66"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path to the setting")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The block name")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"defaultValue")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the default value to return")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fallbackToGlobalSetting")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"true")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether it should fallback to global setting if blockName is passed but setting does not exist")))),(0,r.kt)("h4",{id:"returns-68"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"defined-in-92"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/useThemeSetting.ts#L22"},"packages/core/src/react/provider/useThemeSetting.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usethemesettings"},"useThemeSettings"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useThemeSettings"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"radius?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"style?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"width?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"background?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"custom?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customDuotone?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customGradient?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultGradients?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultPalette?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"duotone?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotone"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotone"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"gradients?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradient"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradient"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"palette?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpalette"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPalette"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"text?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"custom?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"[k: string]"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsCustomAdditionalProperties")),"; } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"layout?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"contentSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wideSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"blockGap?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"margin?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"padding?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"units?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[] } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"customFontSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"dropCap?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontFamilies?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"fontFamily?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontSizes?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"size?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontStyle?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontWeight?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"letterSpacing?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"lineHeight?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"textDecoration?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"textTransform?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } }"),(0,r.kt)("p",null,"Returns the raw theme.json settings definitions"),(0,r.kt)("h4",{id:"returns-69"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"radius?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"style?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"width?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"background?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"custom?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customDuotone?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customGradient?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultGradients?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultPalette?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"duotone?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotone"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotone"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"gradients?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradient"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradient"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"palette?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpalette"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPalette"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"text?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"custom?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"[k: string]"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsCustomAdditionalProperties")),"; } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"layout?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"contentSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wideSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"blockGap?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"margin?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"padding?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"units?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[] } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"customFontSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"dropCap?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontFamilies?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"fontFamily?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontSizes?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"size?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontStyle?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontWeight?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"letterSpacing?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"lineHeight?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"textDecoration?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"textTransform?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } }"),(0,r.kt)("h4",{id:"defined-in-93"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/useThemeSettings.ts#L9"},"packages/core/src/react/provider/useThemeSettings.ts:9")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usethemestyles"},"useThemeStyles"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useThemeStyles"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"elements?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"h1?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h2?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h3?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h4?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h5?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h6?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," }"),(0,r.kt)("p",null,"Returns the theme.json styles definitions"),(0,r.kt)("h4",{id:"returns-70"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"elements?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"h1?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h2?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h3?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h4?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h5?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h6?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," }"),(0,r.kt)("h4",{id:"defined-in-94"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/useThemeStyles.ts#L9"},"packages/core/src/react/provider/useThemeStyles.ts:9")),(0,r.kt)("h2",{id:"react-components"},"React Components"),(0,r.kt)("h3",{id:"blocksrenderer"},"BlocksRenderer"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"BlocksRenderer"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"BlocksRenderer")," components provides an easy way to convert HTML markup into corresponding\nReact components."),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"BlocksRenderer")," component takes in arbitrary html markup and receives a list of react components\nas children that allows replacing dom nodes with React Components."),(0,r.kt)("p",null,"The html prop is sanitized through ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#wpksespost"},"wpKsesPost")," so it's safe for rendering arbitrary html markup."),(0,r.kt)("p",null,"The children components must implement the ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},"BlockProps")," interface"),(0,r.kt)("h2",{id:"usage-1"},"Usage"),(0,r.kt)("h3",{id:"usage-with-the-test-function"},"Usage with the test function"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"\n isAnchorTag(node, { isInternalLink: true })} />\n\n")),(0,r.kt)("h3",{id:"usage-with-classlist-and-tagname-props"},"Usage with classList and tagName props"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},'\n \n\n')),(0,r.kt)("h4",{id:"parameters-67"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.BlockRendererProps"},(0,r.kt)("inlineCode",{parentName:"a"},"BlockRendererProps"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")))),(0,r.kt)("h4",{id:"returns-71"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-95"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L165"},"packages/core/src/react/components/BlocksRenderer.tsx:165")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"htmldecoder"},"HtmlDecoder"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"HtmlDecoder"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"context?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"HtmlDecoder")," simply decodes html entities"),(0,r.kt)("p",null,"Any actual html markup gets stripped before decoding html entities. If you need to render HTML use ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#safehtml"},"SafeHtml")),(0,r.kt)("h2",{id:"usage-2"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},'\n')),(0,r.kt)("h4",{id:"parameters-68"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps"},(0,r.kt)("inlineCode",{parentName:"a"},"HtmlDecodeProps")),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"context?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-72"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-96"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/react/index.d.ts:542"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"safehtml"},"SafeHtml"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"SafeHtml"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"context?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"SafeHtml")," component provides an easy way to safely render HTML"),(0,r.kt)("p",null,"The html prop is sanitized through ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#wpksespost"},"wpKsesPost")," so it's safe for rendering arbitrary html markup."),(0,r.kt)("h2",{id:"usage-3"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},'\n')),(0,r.kt)("h4",{id:"parameters-69"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps"},(0,r.kt)("inlineCode",{parentName:"a"},"SafeHtmlProps")),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"context?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-73"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-97"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/react/index.d.ts:542"))}m.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2398],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>N});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function p(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var o=n.createContext({}),s=function(e){var t=n.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=s(e.components);return n.createElement(o.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},c=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,p=e.originalType,o=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=s(a),c=r,N=m["".concat(o,".").concat(c)]||m[c]||k[c]||p;return a?n.createElement(N,i(i({ref:t},d),{},{components:a})):n.createElement(N,i({ref:t},d))}));function N(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var p=a.length,i=new Array(p);i[0]=c;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l[m]="string"==typeof e?e:r,i[1]=l;for(var s=2;s{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>m,frontMatter:()=>p,metadata:()=>l,toc:()=>s});var n=a(7462),r=(a(7294),a(3905));const p={id:"headstartwp_core.react",title:"Namespace: react",sidebar_label:"@headstartwp/core.react",custom_edit_url:null},i=void 0,l={unversionedId:"namespaces/headstartwp_core.react",id:"namespaces/headstartwp_core.react",title:"Namespace: react",description:"@headstartwp/core.react",source:"@site/docs/namespaces/headstartwp_core.react.md",sourceDirName:"namespaces",slug:"/namespaces/headstartwp_core.react",permalink:"/docs/api/namespaces/headstartwp_core.react",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react",title:"Namespace: react",sidebar_label:"@headstartwp/core.react",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/next",permalink:"/docs/api/modules/headstartwp_next"},next:{title:"@headstartwp/next.config",permalink:"/docs/api/namespaces/headstartwp_next.config"}},o={},s=[{value:"@headstartwp/core/react",id:"headstartwpcorereact",level:2},{value:"Usage",id:"usage",level:3},{value:"Interfaces",id:"interfaces",level:2},{value:"Blocks",id:"blocks",level:2},{value:"AudioBlock",id:"audioblock",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"ButtonBlock",id:"buttonblock",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"ButtonsBlock",id:"buttonsblock",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"CodeBlock",id:"codeblock",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Data Fetching Hooks",id:"data-fetching-hooks",level:2},{value:"useFetch",id:"usefetch",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"useFetchAppSettings",id:"usefetchappsettings",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"useFetchMenu",id:"usefetchmenu",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"useFetchPosts",id:"usefetchposts",level:3},{value:"Type parameters",id:"type-parameters-2",level:4},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"useFetchSearch",id:"usefetchsearch",level:3},{value:"Type parameters",id:"type-parameters-3",level:4},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"useFetchTerms",id:"usefetchterms",level:3},{value:"Type parameters",id:"type-parameters-4",level:4},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"Other",id:"other",level:2},{value:"Align",id:"align",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"Border",id:"border",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"DataFetchingProviderProps",id:"datafetchingproviderprops",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"ItemWrapper",id:"itemwrapper",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Parameters",id:"parameters-10",level:5},{value:"Returns",id:"returns-10",level:5},{value:"Defined in",id:"defined-in-13",level:4},{value:"ItemWrapperProps",id:"itemwrapperprops",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"LinkWrapper",id:"linkwrapper",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Parameters",id:"parameters-11",level:5},{value:"Returns",id:"returns-11",level:5},{value:"Defined in",id:"defined-in-15",level:4},{value:"LinkWrapperProps",id:"linkwrapperprops",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"MenuItemsProp",id:"menuitemsprop",level:3},{value:"Type declaration",id:"type-declaration-4",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"MenuWrapper",id:"menuwrapper",level:3},{value:"Type declaration",id:"type-declaration-5",level:4},{value:"Parameters",id:"parameters-12",level:5},{value:"Returns",id:"returns-12",level:5},{value:"Defined in",id:"defined-in-18",level:4},{value:"MenuWrapperProps",id:"menuwrapperprops",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"PageType",id:"pagetype",level:3},{value:"Type declaration",id:"type-declaration-6",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"SettingsColorPalette",id:"settingscolorpalette",level:3},{value:"Type declaration",id:"type-declaration-7",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"SettingsColorPreset",id:"settingscolorpreset",level:3},{value:"Type declaration",id:"type-declaration-8",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"SettingsContextProps",id:"settingscontextprops",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"SettingsDuotone",id:"settingsduotone",level:3},{value:"Type declaration",id:"type-declaration-9",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"SettingsDuotonePreset",id:"settingsduotonepreset",level:3},{value:"Type declaration",id:"type-declaration-10",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"SettingsGradient",id:"settingsgradient",level:3},{value:"Type declaration",id:"type-declaration-11",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"SettingsGradientPreset",id:"settingsgradientpreset",level:3},{value:"Type declaration",id:"type-declaration-12",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"SettingsPropertiesComplete",id:"settingspropertiescomplete",level:3},{value:"Defined in",id:"defined-in-28",level:4},{value:"Spacing",id:"spacing",level:3},{value:"Type declaration",id:"type-declaration-13",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"Style",id:"style",level:3},{value:"Type declaration",id:"type-declaration-14",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"StylesPropertiesAndElementsComplete",id:"stylespropertiesandelementscomplete",level:3},{value:"Defined in",id:"defined-in-31",level:4},{value:"StylesPropertiesComplete",id:"stylespropertiescomplete",level:3},{value:"Defined in",id:"defined-in-32",level:4},{value:"ThemeJSON",id:"themejson",level:3},{value:"Defined in",id:"defined-in-33",level:4},{value:"SettingsContext",id:"settingscontext",level:3},{value:"Defined in",id:"defined-in-34",level:4},{value:"ThemeSettingsContext",id:"themesettingscontext",level:3},{value:"Defined in",id:"defined-in-35",level:4},{value:"defaultElement",id:"defaultelement",level:3},{value:"Defined in",id:"defined-in-36",level:4},{value:"ColumnBlock",id:"columnblock",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-37",level:4},{value:"ColumnsBlock",id:"columnsblock",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-38",level:4},{value:"CoverBlock",id:"coverblock",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-39",level:4},{value:"DataFetchingProvider",id:"datafetchingprovider",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"DebugBlock",id:"debugblock",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"FileBlock",id:"fileblock",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Defined in",id:"defined-in-42",level:4},{value:"GroupBlock",id:"groupblock",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Defined in",id:"defined-in-43",level:4},{value:"HeadingBlock",id:"headingblock",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Defined in",id:"defined-in-44",level:4},{value:"ImageBlock",id:"imageblock",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Defined in",id:"defined-in-45",level:4},{value:"ListBlock",id:"listblock",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-22",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"MediaTextBlock",id:"mediatextblock",level:3},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"Menu",id:"menu",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-24",level:4},{value:"Defined in",id:"defined-in-48",level:4},{value:"MenuItems",id:"menuitems",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Defined in",id:"defined-in-49",level:4},{value:"ParagraphBlock",id:"paragraphblock",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-26",level:4},{value:"Defined in",id:"defined-in-50",level:4},{value:"PreformattedBlock",id:"preformattedblock",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-27",level:4},{value:"Defined in",id:"defined-in-51",level:4},{value:"PullQuoteBlock",id:"pullquoteblock",level:3},{value:"Parameters",id:"parameters-28",level:4},{value:"Returns",id:"returns-28",level:4},{value:"Defined in",id:"defined-in-52",level:4},{value:"QuoteBlock",id:"quoteblock",level:3},{value:"Parameters",id:"parameters-29",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Defined in",id:"defined-in-53",level:4},{value:"SeparatorBlock",id:"separatorblock",level:3},{value:"Parameters",id:"parameters-30",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Defined in",id:"defined-in-54",level:4},{value:"SettingsProvider",id:"settingsprovider",level:3},{value:"Parameters",id:"parameters-31",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Defined in",id:"defined-in-55",level:4},{value:"SpacerBlock",id:"spacerblock",level:3},{value:"Parameters",id:"parameters-32",level:4},{value:"Returns",id:"returns-32",level:4},{value:"Defined in",id:"defined-in-56",level:4},{value:"TableBlock",id:"tableblock",level:3},{value:"Parameters",id:"parameters-33",level:4},{value:"Returns",id:"returns-33",level:4},{value:"Defined in",id:"defined-in-57",level:4},{value:"ThemeSettingsProvider",id:"themesettingsprovider",level:3},{value:"Parameters",id:"parameters-34",level:4},{value:"Returns",id:"returns-34",level:4},{value:"Defined in",id:"defined-in-58",level:4},{value:"VerseBlock",id:"verseblock",level:3},{value:"Parameters",id:"parameters-35",level:4},{value:"Returns",id:"returns-35",level:4},{value:"Defined in",id:"defined-in-59",level:4},{value:"YoutubeLiteBlock",id:"youtubeliteblock",level:3},{value:"Parameters",id:"parameters-36",level:4},{value:"Returns",id:"returns-36",level:4},{value:"Defined in",id:"defined-in-60",level:4},{value:"getAlignStyle",id:"getalignstyle",level:3},{value:"Parameters",id:"parameters-37",level:4},{value:"Returns",id:"returns-37",level:4},{value:"Defined in",id:"defined-in-61",level:4},{value:"getBlockStyle",id:"getblockstyle",level:3},{value:"Parameters",id:"parameters-38",level:4},{value:"Returns",id:"returns-38",level:4},{value:"Defined in",id:"defined-in-62",level:4},{value:"getColorStyles",id:"getcolorstyles",level:3},{value:"Parameters",id:"parameters-39",level:4},{value:"Returns",id:"returns-39",level:4},{value:"Defined in",id:"defined-in-63",level:4},{value:"getInlineStyles",id:"getinlinestyles",level:3},{value:"Parameters",id:"parameters-40",level:4},{value:"Returns",id:"returns-40",level:4},{value:"Defined in",id:"defined-in-64",level:4},{value:"getTypographyStyles",id:"gettypographystyles",level:3},{value:"Parameters",id:"parameters-41",level:4},{value:"Returns",id:"returns-41",level:4},{value:"Defined in",id:"defined-in-65",level:4},{value:"getWidthStyles",id:"getwidthstyles",level:3},{value:"Parameters",id:"parameters-42",level:4},{value:"Returns",id:"returns-42",level:4},{value:"Defined in",id:"defined-in-66",level:4},{value:"parseSeo",id:"parseseo",level:3},{value:"Parameters",id:"parameters-43",level:4},{value:"Returns",id:"returns-43",level:4},{value:"Defined in",id:"defined-in-67",level:4},{value:"safeArraySpread",id:"safearrayspread",level:3},{value:"Parameters",id:"parameters-44",level:4},{value:"Returns",id:"returns-44",level:4},{value:"Defined in",id:"defined-in-68",level:4},{value:"serializeKey",id:"serializekey",level:3},{value:"Parameters",id:"parameters-45",level:4},{value:"Returns",id:"returns-45",level:4},{value:"Defined in",id:"defined-in-69",level:4},{value:"useBlock",id:"useblock",level:3},{value:"Type parameters",id:"type-parameters-5",level:4},{value:"Parameters",id:"parameters-46",level:4},{value:"Returns",id:"returns-46",level:4},{value:"Defined in",id:"defined-in-70",level:4},{value:"useBlockAlign",id:"useblockalign",level:3},{value:"Parameters",id:"parameters-47",level:4},{value:"Returns",id:"returns-47",level:4},{value:"Defined in",id:"defined-in-71",level:4},{value:"useBlockAttributes",id:"useblockattributes",level:3},{value:"Parameters",id:"parameters-48",level:4},{value:"Returns",id:"returns-48",level:4},{value:"Defined in",id:"defined-in-72",level:4},{value:"useBlockBorder",id:"useblockborder",level:3},{value:"Parameters",id:"parameters-49",level:4},{value:"Returns",id:"returns-49",level:4},{value:"Defined in",id:"defined-in-73",level:4},{value:"useBlockColors",id:"useblockcolors",level:3},{value:"Parameters",id:"parameters-50",level:4},{value:"Returns",id:"returns-50",level:4},{value:"Defined in",id:"defined-in-74",level:4},{value:"useBlockSpacing",id:"useblockspacing",level:3},{value:"Parameters",id:"parameters-51",level:4},{value:"Returns",id:"returns-51",level:4},{value:"Defined in",id:"defined-in-75",level:4},{value:"useBlockStyle",id:"useblockstyle",level:3},{value:"Parameters",id:"parameters-52",level:4},{value:"Returns",id:"returns-52",level:4},{value:"Defined in",id:"defined-in-76",level:4},{value:"useBlockTypography",id:"useblocktypography",level:3},{value:"Parameters",id:"parameters-53",level:4},{value:"Returns",id:"returns-53",level:4},{value:"Defined in",id:"defined-in-77",level:4},{value:"useBlockWidth",id:"useblockwidth",level:3},{value:"Parameters",id:"parameters-54",level:4},{value:"Returns",id:"returns-54",level:4},{value:"Defined in",id:"defined-in-78",level:4},{value:"useFetchAuthorArchive",id:"usefetchauthorarchive",level:3},{value:"Type parameters",id:"type-parameters-6",level:4},{value:"Parameters",id:"parameters-55",level:4},{value:"Returns",id:"returns-55",level:4},{value:"Defined in",id:"defined-in-79",level:4},{value:"useFetchPost",id:"usefetchpost",level:3},{value:"Type parameters",id:"type-parameters-7",level:4},{value:"Parameters",id:"parameters-56",level:4},{value:"Returns",id:"returns-56",level:4},{value:"Defined in",id:"defined-in-80",level:4},{value:"useFetchPostOrPosts",id:"usefetchpostorposts",level:3},{value:"Type parameters",id:"type-parameters-8",level:4},{value:"Parameters",id:"parameters-57",level:4},{value:"Returns",id:"returns-57",level:4},{value:"Defined in",id:"defined-in-81",level:4},{value:"useSWR",id:"useswr",level:3},{value:"Type parameters",id:"type-parameters-9",level:4},{value:"Parameters",id:"parameters-58",level:4},{value:"Returns",id:"returns-58",level:4},{value:"Defined in",id:"defined-in-82",level:4},{value:"Type parameters",id:"type-parameters-10",level:4},{value:"Parameters",id:"parameters-59",level:4},{value:"Returns",id:"returns-59",level:4},{value:"Defined in",id:"defined-in-83",level:4},{value:"Type parameters",id:"type-parameters-11",level:4},{value:"Parameters",id:"parameters-60",level:4},{value:"Returns",id:"returns-60",level:4},{value:"Defined in",id:"defined-in-84",level:4},{value:"Type parameters",id:"type-parameters-12",level:4},{value:"Parameters",id:"parameters-61",level:4},{value:"Returns",id:"returns-61",level:4},{value:"Defined in",id:"defined-in-85",level:4},{value:"Type parameters",id:"type-parameters-13",level:4},{value:"Parameters",id:"parameters-62",level:4},{value:"Returns",id:"returns-62",level:4},{value:"Defined in",id:"defined-in-86",level:4},{value:"Type parameters",id:"type-parameters-14",level:4},{value:"Parameters",id:"parameters-63",level:4},{value:"Returns",id:"returns-63",level:4},{value:"Defined in",id:"defined-in-87",level:4},{value:"Type parameters",id:"type-parameters-15",level:4},{value:"Parameters",id:"parameters-64",level:4},{value:"Returns",id:"returns-64",level:4},{value:"Defined in",id:"defined-in-88",level:4},{value:"Type parameters",id:"type-parameters-16",level:4},{value:"Parameters",id:"parameters-65",level:4},{value:"Returns",id:"returns-65",level:4},{value:"Defined in",id:"defined-in-89",level:4},{value:"useSWRConfig",id:"useswrconfig",level:3},{value:"Returns",id:"returns-66",level:4},{value:"Defined in",id:"defined-in-90",level:4},{value:"useSettings",id:"usesettings",level:3},{value:"Returns",id:"returns-67",level:4},{value:"Defined in",id:"defined-in-91",level:4},{value:"useThemeSetting",id:"usethemesetting",level:3},{value:"Parameters",id:"parameters-66",level:4},{value:"Returns",id:"returns-68",level:4},{value:"Defined in",id:"defined-in-92",level:4},{value:"useThemeSettings",id:"usethemesettings",level:3},{value:"Returns",id:"returns-69",level:4},{value:"Defined in",id:"defined-in-93",level:4},{value:"useThemeStyles",id:"usethemestyles",level:3},{value:"Returns",id:"returns-70",level:4},{value:"Defined in",id:"defined-in-94",level:4},{value:"React Components",id:"react-components",level:2},{value:"BlocksRenderer",id:"blocksrenderer",level:3},{value:"Usage",id:"usage-1",level:2},{value:"Usage with the test function",id:"usage-with-the-test-function",level:3},{value:"Usage with classList and tagName props",id:"usage-with-classlist-and-tagname-props",level:3},{value:"Parameters",id:"parameters-67",level:4},{value:"Returns",id:"returns-71",level:4},{value:"Defined in",id:"defined-in-95",level:4},{value:"HtmlDecoder",id:"htmldecoder",level:3},{value:"Usage",id:"usage-2",level:2},{value:"Parameters",id:"parameters-68",level:4},{value:"Returns",id:"returns-72",level:4},{value:"Defined in",id:"defined-in-96",level:4},{value:"SafeHtml",id:"safehtml",level:3},{value:"Usage",id:"usage-3",level:2},{value:"Parameters",id:"parameters-69",level:4},{value:"Returns",id:"returns-73",level:4},{value:"Defined in",id:"defined-in-97",level:4}],d={toc:s};function m(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".react"),(0,r.kt)("h2",{id:"headstartwpcorereact"},"@headstartwp/core/react"),(0,r.kt)("p",null,"The react export of the ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/core")," package."),(0,r.kt)("h3",{id:"usage"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},'import { BlocksRenderer } from "@headstartwp/core/react";\n')),(0,r.kt)("h2",{id:"interfaces"},"Interfaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},"AudioBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.BlockAttributes"},"BlockAttributes")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},"BlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.BlockRendererProps"},"BlockRendererProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},"ButtonBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},"ButtonsBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},"CodeBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},"ColumnBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},"ColumnsBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},"CoverBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},"FetchHookOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},"FileBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},"GroupBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.GutenbergBlockProps"},"GutenbergBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},"HeadingBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps"},"HtmlDecodeProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock"},"IAudioBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock"},"IButtonBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock"},"IButtonsBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock"},"ICodeBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock"},"IColumnBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock"},"IColumnsBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ICoverBlock"},"ICoverBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IDataWPBlock"},"IDataWPBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IFileBlock"},"IFileBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock"},"IGroupBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock"},"IHeadingBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"},"IImageBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IListBlock"},"IListBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock"},"IMediaTextBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock"},"IParagraphBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock"},"IPreformattedBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock"},"IPullQuoteBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock"},"IQuoteBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock"},"ISeparatorBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock"},"ISpacerBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ITableBlock"},"ITableBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock"},"IVerseBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock"},"IYoutubeLiteBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},"ImageBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},"ListBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},"MediaTextBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},"ParagraphBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},"PreformattedBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},"PullQuoteBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},"QuoteBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps"},"SafeHtmlProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"},"SeparatorBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},"SettingsCustomAdditionalProperties")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},"SettingsProperties")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},"SpacerBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete"},"StylesElementsPropertiesComplete")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},"StylesProperties")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},"TableBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},"Typography")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},"VerseBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.WpThemeJSON"},"WpThemeJSON")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},"YoutubeLiteBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"},"useAppSettingsResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.useFetchOptions"},"useFetchOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"},"useMenuResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"},"usePostOrPostResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"},"usePostResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},"usePostsResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"},"useSearchResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"},"useTermsResponse"))),(0,r.kt)("h2",{id:"blocks"},"Blocks"),(0,r.kt)("h3",{id:"audioblock"},"AudioBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"AudioBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The AudioBlock components implements block parsing for the Audio block."),(0,r.kt)("p",null,"This component must be used within a ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," component."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"\n \n\n")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IAudioBlock"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/AudioBlock.tsx#L58"},"packages/core/src/react/blocks/AudioBlock.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"buttonblock"},"ButtonBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ButtonBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The ButtonBlock component implements block parsing for the Button block."),(0,r.kt)("p",null,"This component must be used within a ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," component."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"\n \n\n")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IButtonBlock"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/ButtonBlock.tsx#L62"},"packages/core/src/react/blocks/ButtonBlock.tsx:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"buttonsblock"},"ButtonsBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ButtonsBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The ButtonsBlock component implements block parsing for the Buttons block."),(0,r.kt)("p",null,"This component must be used within a ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," component."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"\n \n\n")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IButtonsBlock"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/ButtonsBlock.tsx#L28"},"packages/core/src/react/blocks/ButtonsBlock.tsx:28")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"codeblock"},"CodeBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"CodeBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The CodeBlock component implements block parsing for the core/code block."),(0,r.kt)("p",null,"This component must be used within a ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," component."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"\n \n\n")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"ICodeBlock"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/CodeBlock.tsx#L32"},"packages/core/src/react/blocks/CodeBlock.tsx:32")),(0,r.kt)("h2",{id:"data-fetching-hooks"},"Data Fetching Hooks"),(0,r.kt)("h3",{id:"usefetch"},"useFetch"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetch"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"E"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Params"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"R"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchStrategy"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The use Fetch Hook is the foundation for most hooks in the headless framework. It is a wrapper around\n",(0,r.kt)("inlineCode",{parentName:"p"},"useSWR")," and provides a consistent API for fetching data from the API. It requires a fetch strategy which implements\nthe actual data fetching logic"),(0,r.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"E")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"E"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,r.kt)("inlineCode",{parentName:"a"},"EndpointParams")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"R")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"E"))))),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetchStrategy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,r.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"E"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Params"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The fetch strategy.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"R"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path of the url to get url params from.")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The returned data of the fetcher function.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The error object thrown by the fetcher function.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isLoading")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isMainQuery")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isValidating")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"mutate")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"KeyedMutator"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"R"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/useFetch.ts#L30"},"packages/core/src/react/hooks/useFetch.ts:30")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchappsettings"},"useFetchAppSettings"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchAppSettings"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useAppSettingsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useAppSettings hook"),(0,r.kt)("p",null,"See useAppSettings"),(0,r.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AppEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AppEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,r.kt)("inlineCode",{parentName:"a"},"EndpointParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,r.kt)("inlineCode",{parentName:"a"},"EndpointParams")))))),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useAppSettingsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/useFetchAppSettings.ts#L21"},"packages/core/src/react/hooks/useFetchAppSettings.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchmenu"},"useFetchMenu"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchMenu"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"menuLocation"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useMenuResponse"))),(0,r.kt)("p",null,"The useFetchMenu hooks. Returns a Menu object."),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"menuLocation")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The slug of the menu location you want to fetch")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AppEntity")),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"SWR configuration options")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useMenuResponse"))),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/useFetchMenu.ts#L50"},"packages/core/src/react/hooks/useFetchMenu.ts:50")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchposts"},"useFetchPosts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchPosts"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetcher?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useFetchPosts hook. Returns a collection of post entities"),(0,r.kt)("p",null,"See usePosts for usage instructions."),(0,r.kt)("h4",{id:"type-parameters-2"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path of the url to get url params from.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetcher")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveFetchStrategy")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The fetch strategy to use. If none is passed, the default one is used")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/useFetchPosts.ts#L79"},"packages/core/src/react/hooks/useFetchPosts.ts:79")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchsearch"},"useFetchSearch"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchSearch"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useSearchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useFetchSearch hook. Returns a collection of post entities"),(0,r.kt)("p",null,"See useSearch for usage instructions."),(0,r.kt)("h4",{id:"type-parameters-3"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path of the url to get url params from.")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useSearchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/useFetchSearch.ts#L32"},"packages/core/src/react/hooks/useFetchSearch.ts:32")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchterms"},"useFetchTerms"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchTerms"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useTermsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useFetchTerms hook. Returns a collection of term entities"),(0,r.kt)("p",null,"See useTerms for usage instructions."),(0,r.kt)("h4",{id:"type-parameters-4"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams")))))),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path of the url to get url params from.")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useTermsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/useFetchTerms.ts#L29"},"packages/core/src/react/hooks/useFetchTerms.ts:29")),(0,r.kt)("h2",{id:"other"},"Other"),(0,r.kt)("h3",{id:"align"},"Align"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Align"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"none"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"left"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"center"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"right"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"wide"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"full"')),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L15"},"packages/core/src/react/blocks/types.ts:15")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"border"},"Border"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Border"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"radius?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"width?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L65"},"packages/core/src/react/blocks/types.ts:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"datafetchingproviderprops"},"DataFetchingProviderProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"DataFetchingProviderProps"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRConfiguration"),"[",(0,r.kt)("inlineCode",{parentName:"td"},'"fallback"'),"]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"swrConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRConfiguration")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Pass any configuration to the SWR library. Globally. These settings can be overridden at the hook level.")))),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/DataFetchingProvider.tsx#L6"},"packages/core/src/react/provider/DataFetchingProvider.tsx:6")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"itemwrapper"},"ItemWrapper"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ItemWrapper"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#itemwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"ItemWrapperProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h5",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#itemwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"ItemWrapperProps")))))),(0,r.kt)("h5",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/Menu.tsx#L15"},"packages/core/src/react/components/Menu.tsx:15")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"itemwrapperprops"},"ItemWrapperProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ItemWrapperProps"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"PropsWithChildren"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"depth"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"item"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuItemEntity"))," }",">"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/Menu.tsx#L10"},"packages/core/src/react/components/Menu.tsx:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"linkwrapper"},"LinkWrapper"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"LinkWrapper"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#linkwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"LinkWrapperProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h5",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#linkwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"LinkWrapperProps")))))),(0,r.kt)("h5",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/Menu.tsx#L27"},"packages/core/src/react/components/Menu.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"linkwrapperprops"},"LinkWrapperProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"LinkWrapperProps"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"PropsWithChildren"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"depth"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"href"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/Menu.tsx#L23"},"packages/core/src/react/components/Menu.tsx:23")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menuitemsprop"},"MenuItemsProp"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"MenuItemsProp"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-4"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"depth")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"itemWrapper")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#itemwrapper"},(0,r.kt)("inlineCode",{parentName:"a"},"ItemWrapper")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"items")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuItemEntity")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"linkWrapper")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#linkwrapper"},(0,r.kt)("inlineCode",{parentName:"a"},"LinkWrapper")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"menuWrapper")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#menuwrapper"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuWrapper")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"topLevelItemsClickable")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/Menu.tsx#L29"},"packages/core/src/react/components/Menu.tsx:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menuwrapper"},"MenuWrapper"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"MenuWrapper"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#menuwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuWrapperProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"type-declaration-5"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h5",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#menuwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuWrapperProps")))))),(0,r.kt)("h5",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/Menu.tsx#L21"},"packages/core/src/react/components/Menu.tsx:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menuwrapperprops"},"MenuWrapperProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"MenuWrapperProps"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"PropsWithChildren"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"depth"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," }",">"),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/Menu.tsx#L17"},"packages/core/src/react/components/Menu.tsx:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"pagetype"},"PageType"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"PageType"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-6"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isAuthorArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Author Archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isCategoryArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Category Archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isPostArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Regular post archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isPostTypeArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Custom Post Type Archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isSearch")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Search route")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isTagArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Tag Archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isTaxonomyArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Custom Taxonomy Archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"postType")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Which post type this archive is for")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"taxonomy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Which taxonomy this archive is for")))),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/useFetchPosts.ts#L19"},"packages/core/src/react/hooks/useFetchPosts.ts:19")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingscolorpalette"},"SettingsColorPalette"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsColorPalette"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-7"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"theme?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"user?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPreset")),"[]")))),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L47"},"packages/core/src/react/provider/types.ts:47")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingscolorpreset"},"SettingsColorPreset"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsColorPreset"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-8"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"color")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"CSS hex or rgb(a) string.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Name of the color preset, translatable.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Kebab-case unique identifier for the color preset.")))),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L32"},"packages/core/src/react/provider/types.ts:32")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingscontextprops"},"SettingsContextProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsContextProps"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"imageComponent?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"React.FC"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IImageBlock")),">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"linkComponent?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")," } & ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L5"},"packages/core/src/react/provider/types.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingsduotone"},"SettingsDuotone"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsDuotone"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-9"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotonepreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotonePreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"theme?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotonepreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotonePreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"user?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotonepreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotonePreset")),"[]")))),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L89"},"packages/core/src/react/provider/types.ts:89")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingsduotonepreset"},"SettingsDuotonePreset"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsDuotonePreset"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-10"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"colors")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"List of colors from dark to light.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Name of the duotone preset, translatable.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Kebab-case unique identifier for the duotone preset.")))),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L74"},"packages/core/src/react/provider/types.ts:74")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingsgradient"},"SettingsGradient"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsGradient"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-11"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradientpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradientPreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"theme?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradientpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradientPreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"user?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradientpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradientPreset")),"[]")))),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L68"},"packages/core/src/react/provider/types.ts:68")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingsgradientpreset"},"SettingsGradientPreset"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsGradientPreset"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-12"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"gradient")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"CSS gradient string.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Name of the gradient preset, translatable.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Kebab-case unique identifier for the gradient preset.")))),(0,r.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L53"},"packages/core/src/react/provider/types.ts:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingspropertiescomplete"},"SettingsPropertiesComplete"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsPropertiesComplete"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"border"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"color"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"custom?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"custom"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"layout?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"layout"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"spacing"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"typography"'),"]"," }"),(0,r.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L10"},"packages/core/src/react/provider/types.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"spacing"},"Spacing"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Spacing"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-13"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockGap")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"bottom"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"left"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"right"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"top"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.bottom")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.left")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.right")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.top")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"bottom"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"left"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"right"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"top"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.bottom")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.left")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.right")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.top")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"supportsBlockGap")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"supportsMargin")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"supportsPadding")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L40"},"packages/core/src/react/blocks/types.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"Style"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-14"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"border")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,r.kt)("inlineCode",{parentName:"a"},"Border")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"spacing")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,r.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"typography")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,r.kt)("inlineCode",{parentName:"a"},"Typography")))))),(0,r.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L17"},"packages/core/src/react/blocks/types.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"stylespropertiesandelementscomplete"},"StylesPropertiesAndElementsComplete"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"StylesPropertiesAndElementsComplete"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"border"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"color"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"elements?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesElementsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"spacing"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"typography"'),"]"," }"),(0,r.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L24"},"packages/core/src/react/provider/types.ts:24")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"stylespropertiescomplete"},"StylesPropertiesComplete"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"StylesPropertiesComplete"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"border"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"color"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"spacing"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"typography"'),"]"," }"),(0,r.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L18"},"packages/core/src/react/provider/types.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"themejson"},"ThemeJSON"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ThemeJSON"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Pick"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.WpThemeJSON"},(0,r.kt)("inlineCode",{parentName:"a"},"WpThemeJSON")),", ",(0,r.kt)("inlineCode",{parentName:"p"},'"styles"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"settings"'),">"),(0,r.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L352"},"packages/core/src/react/provider/types.ts:352")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingscontext"},"SettingsContext"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"SettingsContext"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Context"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscontextprops"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsContextProps")),">",">"),(0,r.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/Provider.tsx#L5"},"packages/core/src/react/provider/Provider.tsx:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"themesettingscontext"},"ThemeSettingsContext"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"ThemeSettingsContext"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Context"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#themejson"},(0,r.kt)("inlineCode",{parentName:"a"},"ThemeJSON")),">"),(0,r.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/ThemeSettingsProvider.tsx#L4"},"packages/core/src/react/provider/ThemeSettingsProvider.tsx:4")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"defaultelement"},"defaultElement"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"defaultElement"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/hooks/useBlock.ts#L8"},"packages/core/src/react/blocks/hooks/useBlock.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"columnblock"},"ColumnBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ColumnBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IColumnBlock")))))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/ColumnBlock.tsx#L11"},"packages/core/src/react/blocks/ColumnBlock.tsx:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"columnsblock"},"ColumnsBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ColumnsBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IColumnsBlock")))))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/ColumnsBlocks.tsx#L11"},"packages/core/src/react/blocks/ColumnsBlocks.tsx:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"coverblock"},"CoverBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"CoverBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-15"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ICoverBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"ICoverBlock")))))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/CoverBlock.tsx#L24"},"packages/core/src/react/blocks/CoverBlock.tsx:24")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"datafetchingprovider"},"DataFetchingProvider"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"DataFetchingProvider"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"context?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"parameters-16"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#datafetchingproviderprops"},(0,r.kt)("inlineCode",{parentName:"a"},"DataFetchingProviderProps")),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"context?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/react/index.d.ts:542"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"debugblock"},"DebugBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"DebugBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-17"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object"))))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/DebugBlock.tsx#L7"},"packages/core/src/react/blocks/DebugBlock.tsx:7")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fileblock"},"FileBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"FileBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-18"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IFileBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IFileBlock")))))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/FileBlock.tsx#L14"},"packages/core/src/react/blocks/FileBlock.tsx:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"groupblock"},"GroupBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"GroupBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-19"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IGroupBlock")))))),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/GroupBlock.tsx#L17"},"packages/core/src/react/blocks/GroupBlock.tsx:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headingblock"},"HeadingBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"HeadingBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-20"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IHeadingBlock")))))),(0,r.kt)("h4",{id:"returns-20"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/HeadingBlock.tsx#L12"},"packages/core/src/react/blocks/HeadingBlock.tsx:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"imageblock"},"ImageBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ImageBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-21"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IImageBlock")))))),(0,r.kt)("h4",{id:"returns-21"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/ImageBlock.tsx#L19"},"packages/core/src/react/blocks/ImageBlock.tsx:19")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"listblock"},"ListBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ListBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-22"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IListBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IListBlock")))))),(0,r.kt)("h4",{id:"returns-22"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/ListBlock.tsx#L12"},"packages/core/src/react/blocks/ListBlock.tsx:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"mediatextblock"},"MediaTextBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"MediaTextBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-23"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IMediaTextBlock")))))),(0,r.kt)("h4",{id:"returns-23"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/MediaTextBlock.tsx#L22"},"packages/core/src/react/blocks/MediaTextBlock.tsx:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menu"},"Menu"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"Menu"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-24"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"MenuProps"))))),(0,r.kt)("h4",{id:"returns-24"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/Menu.tsx#L109"},"packages/core/src/react/components/Menu.tsx:109")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menuitems"},"MenuItems"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"MenuItems"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-25"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#menuitemsprop"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuItemsProp")))))),(0,r.kt)("h4",{id:"returns-25"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/Menu.tsx#L54"},"packages/core/src/react/components/Menu.tsx:54")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"paragraphblock"},"ParagraphBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ParagraphBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-26"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IParagraphBlock")))))),(0,r.kt)("h4",{id:"returns-26"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/ParagraphBlock.tsx#L13"},"packages/core/src/react/blocks/ParagraphBlock.tsx:13")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"preformattedblock"},"PreformattedBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"PreformattedBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-27"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IPreformattedBlock")))))),(0,r.kt)("h4",{id:"returns-27"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/PreformatedBlock.tsx#L11"},"packages/core/src/react/blocks/PreformatedBlock.tsx:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"pullquoteblock"},"PullQuoteBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"PullQuoteBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-28"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IPullQuoteBlock")))))),(0,r.kt)("h4",{id:"returns-28"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/PullQuote.tsx#L15"},"packages/core/src/react/blocks/PullQuote.tsx:15")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"quoteblock"},"QuoteBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"QuoteBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-29"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IQuoteBlock")))))),(0,r.kt)("h4",{id:"returns-29"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-53"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/QuoteBlock.tsx#L10"},"packages/core/src/react/blocks/QuoteBlock.tsx:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"separatorblock"},"SeparatorBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"SeparatorBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-30"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"ISeparatorBlock")))))),(0,r.kt)("h4",{id:"returns-30"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-54"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/SeparatorBlock.tsx#L10"},"packages/core/src/react/blocks/SeparatorBlock.tsx:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingsprovider"},"SettingsProvider"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"SettingsProvider"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"context?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"parameters-31"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ProviderProps"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"context?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns-31"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-55"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/react/index.d.ts:542"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"spacerblock"},"SpacerBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"SpacerBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-32"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"ISpacerBlock")))))),(0,r.kt)("h4",{id:"returns-32"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-56"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/SpacerBlock.tsx#L12"},"packages/core/src/react/blocks/SpacerBlock.tsx:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tableblock"},"TableBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"TableBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-33"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ITableBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"ITableBlock")))))),(0,r.kt)("h4",{id:"returns-33"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-57"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/TableBlock.tsx#L12"},"packages/core/src/react/blocks/TableBlock.tsx:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"themesettingsprovider"},"ThemeSettingsProvider"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ThemeSettingsProvider"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"context?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"parameters-34"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ProviderProps"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"context?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns-34"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-58"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/react/index.d.ts:542"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"verseblock"},"VerseBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"VerseBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-35"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IVerseBlock")))))),(0,r.kt)("h4",{id:"returns-35"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-59"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/VerseBlock.tsx#L11"},"packages/core/src/react/blocks/VerseBlock.tsx:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"youtubeliteblock"},"YoutubeLiteBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"YoutubeLiteBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"Renders Youtube embeds with lite-youtube-embed"),(0,r.kt)("h4",{id:"parameters-36"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Omit"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IYoutubeLiteBlock")),", ",(0,r.kt)("inlineCode",{parentName:"td"},'"component"'),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Block props")))),(0,r.kt)("h4",{id:"returns-36"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-60"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/YoutubeLiteBlock.tsx#L41"},"packages/core/src/react/blocks/YoutubeLiteBlock.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getalignstyle"},"getAlignStyle"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAlignStyle"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},'"none"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"left"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"center"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"right"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"wide"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"full"')),(0,r.kt)("h4",{id:"parameters-37"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))))),(0,r.kt)("h4",{id:"returns-37"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},'"none"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"left"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"center"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"right"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"wide"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"full"')),(0,r.kt)("h4",{id:"defined-in-61"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/utils.ts#L5"},"packages/core/src/react/blocks/utils.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getblockstyle"},"getBlockStyle"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getBlockStyle"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the block style (is-style-{block-style})"),(0,r.kt)("h4",{id:"parameters-38"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-38"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"string with block style"),(0,r.kt)("h4",{id:"defined-in-62"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/utils.ts#L39"},"packages/core/src/react/blocks/utils.ts:39")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcolorstyles"},"getColorStyles"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getColorStyles"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,r.kt)("inlineCode",{parentName:"a"},"Colors"))),(0,r.kt)("p",null,"Infer GB color styles from classnames"),(0,r.kt)("h4",{id:"parameters-39"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-39"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,r.kt)("inlineCode",{parentName:"a"},"Colors"))),(0,r.kt)("p",null,"ColorBlockProps object"),(0,r.kt)("h4",{id:"defined-in-63"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/utils.ts#L62"},"packages/core/src/react/blocks/utils.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getinlinestyles"},"getInlineStyles"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getInlineStyles"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Converts inline styles to a stylesObject for use in react components"),(0,r.kt)("h4",{id:"parameters-40"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-40"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-64"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/utils.ts#L120"},"packages/core/src/react/blocks/utils.ts:120")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"gettypographystyles"},"getTypographyStyles"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getTypographyStyles"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Returns the typography styles of a block"),(0,r.kt)("h4",{id:"parameters-41"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-41"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontSize")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"fontSize"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," = ''; ",(0,r.kt)("inlineCode",{parentName:"td"},"lineHeight"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," = '' }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style.fontSize")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style.lineHeight")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-65"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/utils.ts#L177"},"packages/core/src/react/blocks/utils.ts:177")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getwidthstyles"},"getWidthStyles"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getWidthStyles"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the width size of a block"),(0,r.kt)("h4",{id:"parameters-42"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-42"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-66"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/utils.ts#L149"},"packages/core/src/react/blocks/utils.ts:149")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parseseo"},"parseSeo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"parseSeo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"seo"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Element"),"[]"),(0,r.kt)("h4",{id:"parameters-43"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"seo")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"HTMLReactParserOptions")))))),(0,r.kt)("h4",{id:"returns-43"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Element"),"[]"),(0,r.kt)("h4",{id:"defined-in-67"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/utils/parseSeo.ts#L4"},"packages/core/src/react/utils/parseSeo.ts:4")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"safearrayspread"},"safeArraySpread"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"safeArraySpread"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"array"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"[]"),(0,r.kt)("h4",{id:"parameters-44"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"array")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns-44"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any"),"[]"),(0,r.kt)("h4",{id:"defined-in-68"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/utils.ts#L220"},"packages/core/src/react/blocks/utils.ts:220")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"serializekey"},"serializeKey"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"serializeKey"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-45"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Key"))))),(0,r.kt)("h4",{id:"returns-45"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-69"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/core/dist/index.d.ts:17"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblock"},"useBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlock"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"node?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Returns the block name and attributes"),(0,r.kt)("h4",{id:"type-parameters-5"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlockAttributes")))))),(0,r.kt)("h4",{id:"parameters-46"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-46"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"attributes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"className")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-70"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/hooks/useBlock.ts#L38"},"packages/core/src/react/blocks/hooks/useBlock.ts:38")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockalign"},"useBlockAlign"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockAlign"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,r.kt)("inlineCode",{parentName:"a"},"Align"))),(0,r.kt)("p",null,"Returns the block align style (if available)"),(0,r.kt)("h4",{id:"parameters-47"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-47"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,r.kt)("inlineCode",{parentName:"a"},"Align"))),(0,r.kt)("h4",{id:"defined-in-71"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/hooks/useBlockAlign.ts#L16"},"packages/core/src/react/blocks/hooks/useBlockAlign.ts:16")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockattributes"},"useBlockAttributes"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockAttributes"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"useBlockAttributes hooks returns the block attributes for a given block based on what it supports"),(0,r.kt)("h4",{id:"parameters-48"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The reference to the dom node of the block")))),(0,r.kt)("h4",{id:"returns-48"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"align")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,r.kt)("inlineCode",{parentName:"a"},"Align")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockStyle")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"border")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,r.kt)("inlineCode",{parentName:"a"},"Border")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"colors")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,r.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"spacing")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,r.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"typography")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,r.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"width")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-72"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/hooks/useBlockAttributes.ts#L19"},"packages/core/src/react/blocks/hooks/useBlockAttributes.ts:19")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockborder"},"useBlockBorder"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockBorder"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,r.kt)("inlineCode",{parentName:"a"},"Border"))),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-49"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-49"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,r.kt)("inlineCode",{parentName:"a"},"Border"))),(0,r.kt)("h4",{id:"defined-in-73"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/hooks/useBlockBorder.ts#L17"},"packages/core/src/react/blocks/hooks/useBlockBorder.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockcolors"},"useBlockColors"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockColors"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,r.kt)("inlineCode",{parentName:"a"},"Colors"))),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-50"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-50"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,r.kt)("inlineCode",{parentName:"a"},"Colors"))),(0,r.kt)("h4",{id:"defined-in-74"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/hooks/useBlockColors.ts#L25"},"packages/core/src/react/blocks/hooks/useBlockColors.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockspacing"},"useBlockSpacing"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockSpacing"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,r.kt)("inlineCode",{parentName:"a"},"Spacing"))),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-51"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-51"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,r.kt)("inlineCode",{parentName:"a"},"Spacing"))),(0,r.kt)("h4",{id:"defined-in-75"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/hooks/useBlockSpacing.ts#L21"},"packages/core/src/react/blocks/hooks/useBlockSpacing.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockstyle"},"useBlockStyle"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockStyle"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-52"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-52"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-76"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/hooks/useBlockStyle.ts#L10"},"packages/core/src/react/blocks/hooks/useBlockStyle.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblocktypography"},"useBlockTypography"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockTypography"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,r.kt)("inlineCode",{parentName:"a"},"Typography"))),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-53"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-53"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,r.kt)("inlineCode",{parentName:"a"},"Typography"))),(0,r.kt)("h4",{id:"defined-in-77"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/hooks/useBlockTypography.ts#L25"},"packages/core/src/react/blocks/hooks/useBlockTypography.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockwidth"},"useBlockWidth"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockWidth"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-54"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-54"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-78"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/hooks/useBlockWidth.ts#L16"},"packages/core/src/react/blocks/hooks/useBlockWidth.ts:16")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchauthorarchive"},"useFetchAuthorArchive"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchAuthorArchive"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useFetchAuthorArchive hook"),(0,r.kt)("p",null,"See useAuthorArchive"),(0,r.kt)("h4",{id:"type-parameters-6"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,r.kt)("h4",{id:"parameters-55"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path of the url to get url params from.")))),(0,r.kt)("h4",{id:"returns-55"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-79"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/useFetchAuthorArchive.ts#L22"},"packages/core/src/react/hooks/useFetchAuthorArchive.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchpost"},"useFetchPost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchPost"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"type-parameters-7"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostParams")))))),(0,r.kt)("h4",{id:"parameters-56"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''"))))),(0,r.kt)("h4",{id:"returns-56"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-80"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/useFetchPost.ts#L30"},"packages/core/src/react/hooks/useFetchPost.ts:30")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchpostorposts"},"useFetchPostOrPosts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchPostOrPosts"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostOrPostResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"type-parameters-8"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams")))))),(0,r.kt)("h4",{id:"parameters-57"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#postorpostsfetchstrategyresult"},(0,r.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategyResult")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''"))))),(0,r.kt)("h4",{id:"returns-57"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostOrPostResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-81"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/useFetchPostOrPosts.ts#L32"},"packages/core/src/react/hooks/useFetchPostOrPosts.ts:32")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useswr"},"useSWR"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRKey"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-9"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Key")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"StrictKey"))))),(0,r.kt)("h4",{id:"parameters-58"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"))))),(0,r.kt)("h4",{id:"returns-58"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-82"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:200"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRKey"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetcher"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-10"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Key")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"StrictKey"))))),(0,r.kt)("h4",{id:"parameters-59"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetcher")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">")))),(0,r.kt)("h4",{id:"returns-59"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-83"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:201"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRKey"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-11"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Key")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"StrictKey"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">",">",">"," = ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">",">",">")))),(0,r.kt)("h4",{id:"parameters-60"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions"))))),(0,r.kt)("h4",{id:"returns-60"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("h4",{id:"defined-in-84"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:202"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRKey"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetcher"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-12"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Key")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"StrictKey"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">",">",">"," = ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">",">",">")))),(0,r.kt)("h4",{id:"parameters-61"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetcher")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions"))))),(0,r.kt)("h4",{id:"returns-61"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("h4",{id:"defined-in-85"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:203"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-13"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"parameters-62"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Key"))))),(0,r.kt)("h4",{id:"returns-62"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-86"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:204"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetcher"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-14"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"parameters-63"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Key"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetcher")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">")))),(0,r.kt)("h4",{id:"returns-63"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-87"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:205"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-15"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">",">",">"," = ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">",">",">")))),(0,r.kt)("h4",{id:"parameters-64"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Key"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions"))))),(0,r.kt)("h4",{id:"returns-64"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("h4",{id:"defined-in-88"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:206"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetcher"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-16"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">",">",">"," = ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">",">",">")))),(0,r.kt)("h4",{id:"parameters-65"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Key"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetcher")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions"))))),(0,r.kt)("h4",{id:"returns-65"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("h4",{id:"defined-in-89"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:207"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useswrconfig"},"useSWRConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWRConfig"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"FullConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">",">"),(0,r.kt)("h4",{id:"returns-66"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"FullConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">",">"),(0,r.kt)("h4",{id:"defined-in-90"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:336"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usesettings"},"useSettings"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSettings"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscontextprops"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsContextProps")),">"),(0,r.kt)("h4",{id:"returns-67"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscontextprops"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsContextProps")),">"),(0,r.kt)("h4",{id:"defined-in-91"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/useSettings.ts#L4"},"packages/core/src/react/provider/useSettings.ts:4")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usethemesetting"},"useThemeSetting"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useThemeSetting"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"blockName?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultValue?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fallbackToGlobalSetting?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("p",null,"Returns a single theme setting normalized"),(0,r.kt)("h4",{id:"parameters-66"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path to the setting")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The block name")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"defaultValue")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the default value to return")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fallbackToGlobalSetting")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"true")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether it should fallback to global setting if blockName is passed but setting does not exist")))),(0,r.kt)("h4",{id:"returns-68"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"defined-in-92"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/useThemeSetting.ts#L22"},"packages/core/src/react/provider/useThemeSetting.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usethemesettings"},"useThemeSettings"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useThemeSettings"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"radius?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"style?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"width?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"background?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"custom?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customDuotone?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customGradient?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultGradients?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultPalette?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"duotone?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotone"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotone"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"gradients?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradient"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradient"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"palette?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpalette"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPalette"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"text?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"custom?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"[k: string]"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsCustomAdditionalProperties")),"; } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"layout?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"contentSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wideSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"blockGap?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"margin?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"padding?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"units?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[] } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"customFontSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"dropCap?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontFamilies?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"fontFamily?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontSizes?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"size?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontStyle?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontWeight?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"letterSpacing?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"lineHeight?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"textDecoration?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"textTransform?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } }"),(0,r.kt)("p",null,"Returns the raw theme.json settings definitions"),(0,r.kt)("h4",{id:"returns-69"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"radius?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"style?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"width?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"background?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"custom?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customDuotone?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customGradient?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultGradients?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultPalette?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"duotone?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotone"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotone"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"gradients?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradient"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradient"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"palette?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpalette"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPalette"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"text?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"custom?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"[k: string]"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsCustomAdditionalProperties")),"; } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"layout?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"contentSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wideSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"blockGap?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"margin?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"padding?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"units?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[] } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"customFontSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"dropCap?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontFamilies?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"fontFamily?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontSizes?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"size?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontStyle?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontWeight?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"letterSpacing?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"lineHeight?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"textDecoration?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"textTransform?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } }"),(0,r.kt)("h4",{id:"defined-in-93"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/useThemeSettings.ts#L9"},"packages/core/src/react/provider/useThemeSettings.ts:9")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usethemestyles"},"useThemeStyles"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useThemeStyles"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"elements?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"h1?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h2?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h3?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h4?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h5?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h6?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," }"),(0,r.kt)("p",null,"Returns the theme.json styles definitions"),(0,r.kt)("h4",{id:"returns-70"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"elements?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"h1?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h2?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h3?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h4?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h5?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h6?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," }"),(0,r.kt)("h4",{id:"defined-in-94"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/useThemeStyles.ts#L9"},"packages/core/src/react/provider/useThemeStyles.ts:9")),(0,r.kt)("h2",{id:"react-components"},"React Components"),(0,r.kt)("h3",{id:"blocksrenderer"},"BlocksRenderer"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"BlocksRenderer"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"BlocksRenderer")," components provides an easy way to convert HTML markup into corresponding\nReact components."),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"BlocksRenderer")," component takes in arbitrary html markup and receives a list of react components\nas children that allows replacing dom nodes with React Components."),(0,r.kt)("p",null,"The html prop is sanitized through ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#wpksespost"},"wpKsesPost")," so it's safe for rendering arbitrary html markup."),(0,r.kt)("p",null,"The children components must implement the ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},"BlockProps")," interface"),(0,r.kt)("h2",{id:"usage-1"},"Usage"),(0,r.kt)("h3",{id:"usage-with-the-test-function"},"Usage with the test function"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"\n isAnchorTag(node, { isInternalLink: true })} />\n\n")),(0,r.kt)("h3",{id:"usage-with-classlist-and-tagname-props"},"Usage with classList and tagName props"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},'\n \n\n')),(0,r.kt)("h4",{id:"parameters-67"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.BlockRendererProps"},(0,r.kt)("inlineCode",{parentName:"a"},"BlockRendererProps"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")))),(0,r.kt)("h4",{id:"returns-71"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-95"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L165"},"packages/core/src/react/components/BlocksRenderer.tsx:165")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"htmldecoder"},"HtmlDecoder"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"HtmlDecoder"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"context?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"HtmlDecoder")," simply decodes html entities"),(0,r.kt)("p",null,"Any actual html markup gets stripped before decoding html entities. If you need to render HTML use ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#safehtml"},"SafeHtml")),(0,r.kt)("h2",{id:"usage-2"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},'\n')),(0,r.kt)("h4",{id:"parameters-68"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps"},(0,r.kt)("inlineCode",{parentName:"a"},"HtmlDecodeProps")),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"context?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-72"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-96"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/react/index.d.ts:542"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"safehtml"},"SafeHtml"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"SafeHtml"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"context?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"SafeHtml")," component provides an easy way to safely render HTML"),(0,r.kt)("p",null,"The html prop is sanitized through ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#wpksespost"},"wpKsesPost")," so it's safe for rendering arbitrary html markup."),(0,r.kt)("h2",{id:"usage-3"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},'\n')),(0,r.kt)("h4",{id:"parameters-69"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps"},(0,r.kt)("inlineCode",{parentName:"a"},"SafeHtmlProps")),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"context?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-73"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-97"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/react/index.d.ts:542"))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4727697a.1f0a093a.js b/assets/js/4727697a.8278edef.js similarity index 92% rename from assets/js/4727697a.1f0a093a.js rename to assets/js/4727697a.8278edef.js index e20595cee..49456d9f8 100644 --- a/assets/js/4727697a.1f0a093a.js +++ b/assets/js/4727697a.8278edef.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2354],{3905:(e,t,a)=>{a.d(t,{Zo:()=>l,kt:()=>k});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var s=n.createContext({}),o=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},l=function(e){var t=o(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,l=d(e,["components","mdxType","originalType","parentName"]),c=o(a),f=i,k=c["".concat(s,".").concat(f)]||c[f]||h[f]||r;return a?n.createElement(k,p(p({ref:t},l),{},{components:a})):n.createElement(k,p({ref:t},l))}));function k(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=a.length,p=new Array(r);p[0]=f;var d={};for(var s in t)hasOwnProperty.call(t,s)&&(d[s]=t[s]);d.originalType=e,d[c]="string"==typeof e?e:i,p[1]=d;for(var o=2;o{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>r,metadata:()=>d,toc:()=>o});var n=a(7462),i=(a(7294),a(3905));const r={id:"headstartwp_core.RevisionEntity",title:"Interface: RevisionEntity",sidebar_label:"@headstartwp/core.RevisionEntity",custom_edit_url:null},p=void 0,d={unversionedId:"interfaces/headstartwp_core.RevisionEntity",id:"interfaces/headstartwp_core.RevisionEntity",title:"Interface: RevisionEntity",description:"@headstartwp/core.RevisionEntity",source:"@site/docs/interfaces/headstartwp_core.RevisionEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.RevisionEntity",permalink:"/docs/api/interfaces/headstartwp_core.RevisionEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.RevisionEntity",title:"Interface: RevisionEntity",sidebar_label:"@headstartwp/core.RevisionEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Rendered",permalink:"/docs/api/interfaces/headstartwp_core.Rendered"},next:{title:"@headstartwp/core.SearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.SearchEntity"}},s={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"author",id:"author",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"comment_status",id:"comment_status",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"content",id:"content",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"date",id:"date",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"excerpt",id:"excerpt",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"guid",id:"guid",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"link",id:"link",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"modified",id:"modified",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"modified_gmt",id:"modified_gmt",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"parent",id:"parent",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"ping_status",id:"ping_status",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"slug",id:"slug",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"status",id:"status",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"terms",id:"terms",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"type",id:"type",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-20",level:4}],l={toc:o};function c(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},l,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".RevisionEntity"),(0,i.kt)("p",null,"Interface for entities from the /wp/v2/posts/1/revisions endpoint."),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PostTypeEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"RevisionEntity"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"_embedded"},"_","embedded"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"author")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wp:term")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]")))),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#_embedded"},"_embedded")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L98"},"packages/core/src/data/types/entities.ts:98")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"author"},"author"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"author"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#author"},"author")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L94"},"packages/core/src/data/types/entities.ts:94")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"comment_status"},"comment","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"comment","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not comments are open on the object."),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#comment_status"},"comment_status")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L106"},"packages/core/src/data/types/entities.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"content"},"content"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"content"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The content for the object."),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L189"},"packages/core/src/data/types/entities.ts:189")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date"},"date"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date"},"date")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L42"},"packages/core/src/data/types/entities.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, as GMT."),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date_gmt"},"date_gmt")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L47"},"packages/core/src/data/types/entities.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"excerpt"},"excerpt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"excerpt"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The excerpt for the object."),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L194"},"packages/core/src/data/types/entities.ts:194")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"guid"},"guid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"guid"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The globally unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#guid"},"guid")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L52"},"packages/core/src/data/types/entities.ts:52")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#id"},"id")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L67"},"packages/core/src/data/types/entities.ts:67")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"link"},"link"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"link"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the object."),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#link"},"link")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L72"},"packages/core/src/data/types/entities.ts:72")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified"},"modified"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified"},"modified")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L57"},"packages/core/src/data/types/entities.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified_gmt"},"modified","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, as GMT."),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified_gmt"},"modified_gmt")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L62"},"packages/core/src/data/types/entities.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"parent"},"parent"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"parent"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The ID for the parent of the object."),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L184"},"packages/core/src/data/types/entities.ts:184")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ping_status"},"ping","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ping","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not the object can be pinged."),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#ping_status"},"ping_status")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L111"},"packages/core/src/data/types/entities.ts:111")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"slug"},"slug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"slug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"An alphanumeric identifier for the object unique to its type."),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#slug"},"slug")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L77"},"packages/core/src/data/types/entities.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"private"')),(0,i.kt)("p",null,"A named status for the object."),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#status"},"status")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L82"},"packages/core/src/data/types/entities.ts:82")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"terms"},"terms"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"terms"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#terms"},"terms")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L96"},"packages/core/src/data/types/entities.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The title for the object."),(0,i.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#title"},"title")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L92"},"packages/core/src/data/types/entities.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Type of Post for the object."),(0,i.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#type"},"type")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L87"},"packages/core/src/data/types/entities.ts:87")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head"},"yoast_head")),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L114"},"packages/core/src/data/types/entities.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head_json"},"yoast_head_json")),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L113"},"packages/core/src/data/types/entities.ts:113")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2354],{3905:(e,t,a)=>{a.d(t,{Zo:()=>l,kt:()=>f});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var s=n.createContext({}),o=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},l=function(e){var t=o(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,l=d(e,["components","mdxType","originalType","parentName"]),c=o(a),k=i,f=c["".concat(s,".").concat(k)]||c[k]||h[k]||r;return a?n.createElement(f,p(p({ref:t},l),{},{components:a})):n.createElement(f,p({ref:t},l))}));function f(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=a.length,p=new Array(r);p[0]=k;var d={};for(var s in t)hasOwnProperty.call(t,s)&&(d[s]=t[s]);d.originalType=e,d[c]="string"==typeof e?e:i,p[1]=d;for(var o=2;o{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>r,metadata:()=>d,toc:()=>o});var n=a(7462),i=(a(7294),a(3905));const r={id:"headstartwp_core.RevisionEntity",title:"Interface: RevisionEntity",sidebar_label:"@headstartwp/core.RevisionEntity",custom_edit_url:null},p=void 0,d={unversionedId:"interfaces/headstartwp_core.RevisionEntity",id:"interfaces/headstartwp_core.RevisionEntity",title:"Interface: RevisionEntity",description:"@headstartwp/core.RevisionEntity",source:"@site/docs/interfaces/headstartwp_core.RevisionEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.RevisionEntity",permalink:"/docs/api/interfaces/headstartwp_core.RevisionEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.RevisionEntity",title:"Interface: RevisionEntity",sidebar_label:"@headstartwp/core.RevisionEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Rendered",permalink:"/docs/api/interfaces/headstartwp_core.Rendered"},next:{title:"@headstartwp/core.SearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.SearchEntity"}},s={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"author",id:"author",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"comment_status",id:"comment_status",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"content",id:"content",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"date",id:"date",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"excerpt",id:"excerpt",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"guid",id:"guid",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"link",id:"link",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"modified",id:"modified",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"modified_gmt",id:"modified_gmt",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"parent",id:"parent",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"ping_status",id:"ping_status",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"slug",id:"slug",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"status",id:"status",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"terms",id:"terms",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"type",id:"type",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-20",level:4}],l={toc:o};function c(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},l,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".RevisionEntity"),(0,i.kt)("p",null,"Interface for entities from the /wp/v2/posts/1/revisions endpoint."),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PostTypeEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"RevisionEntity"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"_embedded"},"_","embedded"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"author")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wp:term")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]")))),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#_embedded"},"_embedded")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L98"},"packages/core/src/data/types/entities.ts:98")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"author"},"author"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"author"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#author"},"author")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L94"},"packages/core/src/data/types/entities.ts:94")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"comment_status"},"comment","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"comment","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not comments are open on the object."),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#comment_status"},"comment_status")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L106"},"packages/core/src/data/types/entities.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"content"},"content"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"content"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The content for the object."),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L189"},"packages/core/src/data/types/entities.ts:189")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date"},"date"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date"},"date")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L42"},"packages/core/src/data/types/entities.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, as GMT."),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date_gmt"},"date_gmt")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L47"},"packages/core/src/data/types/entities.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"excerpt"},"excerpt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"excerpt"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The excerpt for the object."),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L194"},"packages/core/src/data/types/entities.ts:194")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"guid"},"guid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"guid"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The globally unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#guid"},"guid")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L52"},"packages/core/src/data/types/entities.ts:52")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#id"},"id")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L67"},"packages/core/src/data/types/entities.ts:67")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"link"},"link"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"link"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the object."),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#link"},"link")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L72"},"packages/core/src/data/types/entities.ts:72")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified"},"modified"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified"},"modified")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L57"},"packages/core/src/data/types/entities.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified_gmt"},"modified","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, as GMT."),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified_gmt"},"modified_gmt")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L62"},"packages/core/src/data/types/entities.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"parent"},"parent"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"parent"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The ID for the parent of the object."),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L184"},"packages/core/src/data/types/entities.ts:184")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ping_status"},"ping","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ping","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not the object can be pinged."),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#ping_status"},"ping_status")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L111"},"packages/core/src/data/types/entities.ts:111")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"slug"},"slug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"slug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"An alphanumeric identifier for the object unique to its type."),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#slug"},"slug")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L77"},"packages/core/src/data/types/entities.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"private"')),(0,i.kt)("p",null,"A named status for the object."),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#status"},"status")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L82"},"packages/core/src/data/types/entities.ts:82")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"terms"},"terms"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"terms"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#terms"},"terms")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L96"},"packages/core/src/data/types/entities.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The title for the object."),(0,i.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#title"},"title")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L92"},"packages/core/src/data/types/entities.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Type of Post for the object."),(0,i.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#type"},"type")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L87"},"packages/core/src/data/types/entities.ts:87")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head"},"yoast_head")),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L114"},"packages/core/src/data/types/entities.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head_json"},"yoast_head_json")),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L113"},"packages/core/src/data/types/entities.ts:113")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4917042f.afe5797a.js b/assets/js/4917042f.d759d732.js similarity index 96% rename from assets/js/4917042f.afe5797a.js rename to assets/js/4917042f.d759d732.js index c734fd926..0c11b6b83 100644 --- a/assets/js/4917042f.afe5797a.js +++ b/assets/js/4917042f.d759d732.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6217],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),l=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},d=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},c="mdxType",f={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),c=l(r),m=n,h=c["".concat(p,".").concat(m)]||c[m]||f[m]||i;return r?a.createElement(h,o(o({ref:t},d),{},{components:r})):a.createElement(h,o({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=m;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[c]="string"==typeof e?e:n,o[1]=s;for(var l=2;l{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.VerifyTokenParams",title:"Interface: VerifyTokenParams",sidebar_label:"@headstartwp/core.VerifyTokenParams",custom_edit_url:null},o=void 0,s={unversionedId:"interfaces/headstartwp_core.VerifyTokenParams",id:"interfaces/headstartwp_core.VerifyTokenParams",title:"Interface: VerifyTokenParams",description:"@headstartwp/core.VerifyTokenParams",source:"@site/docs/interfaces/headstartwp_core.VerifyTokenParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.VerifyTokenParams",permalink:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.VerifyTokenParams",title:"Interface: VerifyTokenParams",sidebar_label:"@headstartwp/core.VerifyTokenParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.TypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.TypeEntity"},next:{title:"@headstartwp/core.YoastSEOIntegration",permalink:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"authToken",id:"authtoken",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"lang",id:"lang",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],d={toc:l};function c(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".VerifyTokenParams"),(0,n.kt)("p",null,"The EndpointParams supported by the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy"},"VerifyTokenFetchStrategy")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"VerifyTokenParams"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"_embed"},"_","embed"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"The _embed param returned associated entities in the response"),(0,n.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_embed"},"_embed")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"_fields"},"_","fields"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_fields"},"_fields")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"authtoken"},"authToken"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"authToken"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts#L9"},"packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"lang"},"lang"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"lang"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The polylang ?lang parameter."),(0,n.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#lang"},"lang")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6217],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),l=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},d=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},c="mdxType",f={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),c=l(r),m=n,h=c["".concat(p,".").concat(m)]||c[m]||f[m]||i;return r?a.createElement(h,o(o({ref:t},d),{},{components:r})):a.createElement(h,o({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=m;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[c]="string"==typeof e?e:n,o[1]=s;for(var l=2;l{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.VerifyTokenParams",title:"Interface: VerifyTokenParams",sidebar_label:"@headstartwp/core.VerifyTokenParams",custom_edit_url:null},o=void 0,s={unversionedId:"interfaces/headstartwp_core.VerifyTokenParams",id:"interfaces/headstartwp_core.VerifyTokenParams",title:"Interface: VerifyTokenParams",description:"@headstartwp/core.VerifyTokenParams",source:"@site/docs/interfaces/headstartwp_core.VerifyTokenParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.VerifyTokenParams",permalink:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.VerifyTokenParams",title:"Interface: VerifyTokenParams",sidebar_label:"@headstartwp/core.VerifyTokenParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.TypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.TypeEntity"},next:{title:"@headstartwp/core.YoastSEOIntegration",permalink:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"authToken",id:"authtoken",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"lang",id:"lang",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],d={toc:l};function c(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".VerifyTokenParams"),(0,n.kt)("p",null,"The EndpointParams supported by the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy"},"VerifyTokenFetchStrategy")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"VerifyTokenParams"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"_embed"},"_","embed"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"The _embed param returned associated entities in the response"),(0,n.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_embed"},"_embed")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"_fields"},"_","fields"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_fields"},"_fields")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"authtoken"},"authToken"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"authToken"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts#L9"},"packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"lang"},"lang"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"lang"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The polylang ?lang parameter."),(0,n.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#lang"},"lang")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/499cbdae.3d07fc78.js b/assets/js/499cbdae.9ec183e5.js similarity index 98% rename from assets/js/499cbdae.3d07fc78.js rename to assets/js/499cbdae.9ec183e5.js index e79cf82a5..afdbaa41c 100644 --- a/assets/js/499cbdae.3d07fc78.js +++ b/assets/js/499cbdae.9ec183e5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2089],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),s=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},l=function(e){var t=s(e.components);return n.createElement(p.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},y=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,p=e.parentName,l=c(e,["components","mdxType","originalType","parentName"]),u=s(r),y=a,f=u["".concat(p,".").concat(y)]||u[y]||d[y]||o;return r?n.createElement(f,i(i({ref:t},l),{},{components:r})):n.createElement(f,i({ref:t},l))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=y;var c={};for(var p in t)hasOwnProperty.call(t,p)&&(c[p]=t[p]);c.originalType=e,c[u]="string"==typeof e?e:a,i[1]=c;for(var s=2;s{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>s});var n=r(7462),a=(r(7294),r(3905));const o={sidebar_label:"TypeScript"},i="TypeScript",c={unversionedId:"Guides/typescript",id:"Guides/typescript",title:"TypeScript",description:"",source:"@site/documentation/08-Guides/typescript.md",sourceDirName:"08-Guides",slug:"/Guides/typescript",permalink:"/docs/learn/Guides/typescript",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/08-Guides/typescript.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{sidebar_label:"TypeScript"},sidebar:"tutorialSidebar",previous:{title:"Linaria (CSS-in-JS)",permalink:"/docs/learn/Guides/linaria"},next:{title:"Implementing a Youtube Facade",permalink:"/docs/learn/Guides/youtube-facade"}},p={},s=[],l={toc:s};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"typescript"},"TypeScript"))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2089],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),s=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},l=function(e){var t=s(e.components);return n.createElement(p.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},y=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,p=e.parentName,l=c(e,["components","mdxType","originalType","parentName"]),u=s(r),y=a,f=u["".concat(p,".").concat(y)]||u[y]||d[y]||o;return r?n.createElement(f,i(i({ref:t},l),{},{components:r})):n.createElement(f,i({ref:t},l))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=y;var c={};for(var p in t)hasOwnProperty.call(t,p)&&(c[p]=t[p]);c.originalType=e,c[u]="string"==typeof e?e:a,i[1]=c;for(var s=2;s{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>s});var n=r(7462),a=(r(7294),r(3905));const o={sidebar_label:"TypeScript"},i="TypeScript",c={unversionedId:"Guides/typescript",id:"Guides/typescript",title:"TypeScript",description:"",source:"@site/documentation/08-Guides/typescript.md",sourceDirName:"08-Guides",slug:"/Guides/typescript",permalink:"/docs/learn/Guides/typescript",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/08-Guides/typescript.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{sidebar_label:"TypeScript"},sidebar:"tutorialSidebar",previous:{title:"Linaria (CSS-in-JS)",permalink:"/docs/learn/Guides/linaria"},next:{title:"Implementing a Youtube Facade",permalink:"/docs/learn/Guides/youtube-facade"}},p={},s=[],l={toc:s};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"typescript"},"TypeScript"))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/49db3b24.d55dc78c.js b/assets/js/49db3b24.345b1b7b.js similarity index 94% rename from assets/js/49db3b24.d55dc78c.js rename to assets/js/49db3b24.345b1b7b.js index e0687bf51..e02e7561c 100644 --- a/assets/js/49db3b24.d55dc78c.js +++ b/assets/js/49db3b24.345b1b7b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5281],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>u});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function l(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(r),h=n,u=s["".concat(p,".").concat(h)]||s[h]||k[h]||l;return r?a.createElement(u,i(i({ref:t},d),{},{components:r})):a.createElement(u,i({ref:t},d))}));function u(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=r.length,i=new Array(l);i[0]=h;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const l={id:"headstartwp_core.react.ButtonBlockProps",title:"Interface: ButtonBlockProps",sidebar_label:"@headstartwp/core.react.ButtonBlockProps",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ButtonBlockProps",id:"interfaces/headstartwp_core.react.ButtonBlockProps",title:"Interface: ButtonBlockProps",description:"@headstartwp/core.react.ButtonBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ButtonBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ButtonBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ButtonBlockProps",title:"Interface: ButtonBlockProps",sidebar_label:"@headstartwp/core.react.ButtonBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.BlockRendererProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockRendererProps"},next:{title:"@headstartwp/core.react.ButtonsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"linkTarget",id:"linktarget",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"placeholder",id:"placeholder",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"rel",id:"rel",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"text",id:"text",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-12",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ButtonBlockProps"),(0,n.kt)("p",null,"The interface for components rendered by ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#buttonblock"},"ButtonBlock")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ButtonBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linktarget"},"linkTarget"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"linkTarget"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The link target"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/ButtonBlock.tsx#L31"},"packages/core/src/react/blocks/ButtonBlock.tsx:31")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"placeholder"},"placeholder"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"placeholder"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The link placeholder text"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/ButtonBlock.tsx#L41"},"packages/core/src/react/blocks/ButtonBlock.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"rel"},"rel"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"rel"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The link rel"),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/ButtonBlock.tsx#L36"},"packages/core/src/react/blocks/ButtonBlock.tsx:36")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"text"},"text"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"text"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The button text"),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/ButtonBlock.tsx#L26"},"packages/core/src/react/blocks/ButtonBlock.tsx:26")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"title"},"title"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"title"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The title of the link"),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/ButtonBlock.tsx#L21"},"packages/core/src/react/blocks/ButtonBlock.tsx:21")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"url"},"url"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"url"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The button url"),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/ButtonBlock.tsx#L16"},"packages/core/src/react/blocks/ButtonBlock.tsx:16")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5281],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>u});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function l(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(r),h=n,u=s["".concat(p,".").concat(h)]||s[h]||k[h]||l;return r?a.createElement(u,i(i({ref:t},d),{},{components:r})):a.createElement(u,i({ref:t},d))}));function u(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=r.length,i=new Array(l);i[0]=h;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const l={id:"headstartwp_core.react.ButtonBlockProps",title:"Interface: ButtonBlockProps",sidebar_label:"@headstartwp/core.react.ButtonBlockProps",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ButtonBlockProps",id:"interfaces/headstartwp_core.react.ButtonBlockProps",title:"Interface: ButtonBlockProps",description:"@headstartwp/core.react.ButtonBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ButtonBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ButtonBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ButtonBlockProps",title:"Interface: ButtonBlockProps",sidebar_label:"@headstartwp/core.react.ButtonBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.BlockRendererProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockRendererProps"},next:{title:"@headstartwp/core.react.ButtonsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"linkTarget",id:"linktarget",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"placeholder",id:"placeholder",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"rel",id:"rel",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"text",id:"text",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-12",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ButtonBlockProps"),(0,n.kt)("p",null,"The interface for components rendered by ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#buttonblock"},"ButtonBlock")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ButtonBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linktarget"},"linkTarget"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"linkTarget"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The link target"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/ButtonBlock.tsx#L31"},"packages/core/src/react/blocks/ButtonBlock.tsx:31")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"placeholder"},"placeholder"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"placeholder"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The link placeholder text"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/ButtonBlock.tsx#L41"},"packages/core/src/react/blocks/ButtonBlock.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"rel"},"rel"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"rel"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The link rel"),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/ButtonBlock.tsx#L36"},"packages/core/src/react/blocks/ButtonBlock.tsx:36")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"text"},"text"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"text"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The button text"),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/ButtonBlock.tsx#L26"},"packages/core/src/react/blocks/ButtonBlock.tsx:26")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"title"},"title"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"title"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The title of the link"),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/ButtonBlock.tsx#L21"},"packages/core/src/react/blocks/ButtonBlock.tsx:21")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"url"},"url"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"url"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The button url"),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/ButtonBlock.tsx#L16"},"packages/core/src/react/blocks/ButtonBlock.tsx:16")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4a0d0a3d.0d95f4db.js b/assets/js/4a0d0a3d.4afa3fa6.js similarity index 95% rename from assets/js/4a0d0a3d.0d95f4db.js rename to assets/js/4a0d0a3d.4afa3fa6.js index c5dd5d154..9ea788516 100644 --- a/assets/js/4a0d0a3d.0d95f4db.js +++ b/assets/js/4a0d0a3d.4afa3fa6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8950],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),d=c(r),u=n,m=d["".concat(p,".").concat(u)]||d[u]||k[u]||i;return r?a.createElement(m,l(l({ref:t},s),{},{components:r})):a.createElement(m,l({ref:t},s))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=u;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[d]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.YoutubeLiteBlockProps",title:"Interface: YoutubeLiteBlockProps",sidebar_label:"@headstartwp/core.react.YoutubeLiteBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.YoutubeLiteBlockProps",id:"interfaces/headstartwp_core.react.YoutubeLiteBlockProps",title:"Interface: YoutubeLiteBlockProps",description:"@headstartwp/core.react.YoutubeLiteBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.YoutubeLiteBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.YoutubeLiteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.YoutubeLiteBlockProps",title:"Interface: YoutubeLiteBlockProps",sidebar_label:"@headstartwp/core.react.YoutubeLiteBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.WpThemeJSON",permalink:"/docs/api/interfaces/headstartwp_core.react.WpThemeJSON"},next:{title:"@headstartwp/core.react.useAppSettingsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"src",id:"src",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-8",level:4}],s={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".YoutubeLiteBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"YoutubeLiteBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"src"},"src"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"src"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/YoutubeLiteBlock.tsx#L29"},"packages/core/src/react/blocks/YoutubeLiteBlock.tsx:29")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"title"},"title"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"title"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/YoutubeLiteBlock.tsx#L30"},"packages/core/src/react/blocks/YoutubeLiteBlock.tsx:30")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8950],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),d=c(r),u=n,m=d["".concat(p,".").concat(u)]||d[u]||k[u]||i;return r?a.createElement(m,l(l({ref:t},s),{},{components:r})):a.createElement(m,l({ref:t},s))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=u;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[d]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.YoutubeLiteBlockProps",title:"Interface: YoutubeLiteBlockProps",sidebar_label:"@headstartwp/core.react.YoutubeLiteBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.YoutubeLiteBlockProps",id:"interfaces/headstartwp_core.react.YoutubeLiteBlockProps",title:"Interface: YoutubeLiteBlockProps",description:"@headstartwp/core.react.YoutubeLiteBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.YoutubeLiteBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.YoutubeLiteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.YoutubeLiteBlockProps",title:"Interface: YoutubeLiteBlockProps",sidebar_label:"@headstartwp/core.react.YoutubeLiteBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.WpThemeJSON",permalink:"/docs/api/interfaces/headstartwp_core.react.WpThemeJSON"},next:{title:"@headstartwp/core.react.useAppSettingsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"src",id:"src",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-8",level:4}],s={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".YoutubeLiteBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"YoutubeLiteBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"src"},"src"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"src"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/YoutubeLiteBlock.tsx#L29"},"packages/core/src/react/blocks/YoutubeLiteBlock.tsx:29")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"title"},"title"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"title"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/YoutubeLiteBlock.tsx#L30"},"packages/core/src/react/blocks/YoutubeLiteBlock.tsx:30")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4a5e8971.b1153eff.js b/assets/js/4a5e8971.b2122ec9.js similarity index 94% rename from assets/js/4a5e8971.b1153eff.js rename to assets/js/4a5e8971.b2122ec9.js index 7bad4aa0c..da4540947 100644 --- a/assets/js/4a5e8971.b1153eff.js +++ b/assets/js/4a5e8971.b2122ec9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5534],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>f});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function p(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function o(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var l=r.createContext({}),c=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},s=function(e){var t=c(e.components);return r.createElement(l.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,p=e.originalType,l=e.parentName,s=i(e,["components","mdxType","originalType","parentName"]),d=c(a),m=n,f=d["".concat(l,".").concat(m)]||d[m]||k[m]||p;return a?r.createElement(f,o(o({ref:t},s),{},{components:a})):r.createElement(f,o({ref:t},s))}));function f(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var p=a.length,o=new Array(p);o[0]=m;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[d]="string"==typeof e?e:n,o[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>p,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const p={id:"headstartwp_core.react.IBlockAttributes",title:"Interface: IBlockAttributes",sidebar_label:"@headstartwp/core.react.IBlockAttributes",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IBlockAttributes",id:"interfaces/headstartwp_core.react.IBlockAttributes",title:"Interface: IBlockAttributes",description:"@headstartwp/core.react.IBlockAttributes",source:"@site/docs/interfaces/headstartwp_core.react.IBlockAttributes.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IBlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IBlockAttributes",title:"Interface: IBlockAttributes",sidebar_label:"@headstartwp/core.react.IBlockAttributes",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlock"},next:{title:"@headstartwp/core.react.IButtonBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock"}},l={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:c};function d(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IBlockAttributes"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ButtonBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ButtonsBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"AudioBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CodeBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ColumnsBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ColumnBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CoverBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ParagraphBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadingBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"QuoteBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PullQuoteBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PreformattedBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"VerseBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"TableBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"GroupBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SeparatorBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SpacerBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ListBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"YoutubeLiteBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"FileBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"MediaTextBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ImageBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5534],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function p(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function o(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var l=r.createContext({}),c=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},s=function(e){var t=c(e.components);return r.createElement(l.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,p=e.originalType,l=e.parentName,s=i(e,["components","mdxType","originalType","parentName"]),d=c(a),m=n,h=d["".concat(l,".").concat(m)]||d[m]||k[m]||p;return a?r.createElement(h,o(o({ref:t},s),{},{components:a})):r.createElement(h,o({ref:t},s))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var p=a.length,o=new Array(p);o[0]=m;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[d]="string"==typeof e?e:n,o[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>p,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const p={id:"headstartwp_core.react.IBlockAttributes",title:"Interface: IBlockAttributes",sidebar_label:"@headstartwp/core.react.IBlockAttributes",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IBlockAttributes",id:"interfaces/headstartwp_core.react.IBlockAttributes",title:"Interface: IBlockAttributes",description:"@headstartwp/core.react.IBlockAttributes",source:"@site/docs/interfaces/headstartwp_core.react.IBlockAttributes.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IBlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IBlockAttributes",title:"Interface: IBlockAttributes",sidebar_label:"@headstartwp/core.react.IBlockAttributes",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlock"},next:{title:"@headstartwp/core.react.IButtonBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock"}},l={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:c};function d(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IBlockAttributes"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ButtonBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ButtonsBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"AudioBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CodeBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ColumnsBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ColumnBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CoverBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ParagraphBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadingBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"QuoteBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PullQuoteBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PreformattedBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"VerseBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"TableBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"GroupBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SeparatorBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SpacerBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ListBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"YoutubeLiteBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"FileBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"MediaTextBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ImageBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4bbbe9cb.1e9de729.js b/assets/js/4bbbe9cb.fba2d71f.js similarity index 97% rename from assets/js/4bbbe9cb.1e9de729.js rename to assets/js/4bbbe9cb.fba2d71f.js index 4ae7ece8d..78e0e5372 100644 --- a/assets/js/4bbbe9cb.1e9de729.js +++ b/assets/js/4bbbe9cb.fba2d71f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8327],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.IGroupBlock",title:"Interface: IGroupBlock",sidebar_label:"@headstartwp/core.react.IGroupBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IGroupBlock",id:"interfaces/headstartwp_core.react.IGroupBlock",title:"Interface: IGroupBlock",description:"@headstartwp/core.react.IGroupBlock",source:"@site/docs/interfaces/headstartwp_core.react.IGroupBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IGroupBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IGroupBlock",title:"Interface: IGroupBlock",sidebar_label:"@headstartwp/core.react.IGroupBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IFileBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IFileBlock"},next:{title:"@headstartwp/core.react.IHeadingBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IGroupBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"GroupBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IGroupBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"GroupBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"GroupBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8327],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.IGroupBlock",title:"Interface: IGroupBlock",sidebar_label:"@headstartwp/core.react.IGroupBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IGroupBlock",id:"interfaces/headstartwp_core.react.IGroupBlock",title:"Interface: IGroupBlock",description:"@headstartwp/core.react.IGroupBlock",source:"@site/docs/interfaces/headstartwp_core.react.IGroupBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IGroupBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IGroupBlock",title:"Interface: IGroupBlock",sidebar_label:"@headstartwp/core.react.IGroupBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IFileBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IFileBlock"},next:{title:"@headstartwp/core.react.IHeadingBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IGroupBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"GroupBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IGroupBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"GroupBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"GroupBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4bc3bdcd.bcb11960.js b/assets/js/4bc3bdcd.b30cab50.js similarity index 97% rename from assets/js/4bc3bdcd.bcb11960.js rename to assets/js/4bc3bdcd.b30cab50.js index 0ec0be15c..4eb17bc67 100644 --- a/assets/js/4bc3bdcd.bcb11960.js +++ b/assets/js/4bc3bdcd.b30cab50.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9921],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>f});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function s(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),l=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):s(s({},t),e)),a},d=function(e){var t=l(e.components);return r.createElement(o.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),c=l(a),u=n,f=c["".concat(o,".").concat(u)]||c[u]||m[u]||i;return a?r.createElement(f,s(s({ref:t},d),{},{components:a})):r.createElement(f,s({ref:t},d))}));function f(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,s=new Array(i);s[0]=u;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[c]="string"==typeof e?e:n,s[1]=p;for(var l=2;l{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>s,default:()=>c,frontMatter:()=>i,metadata:()=>p,toc:()=>l});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.EndpointParams",title:"Interface: EndpointParams",sidebar_label:"@headstartwp/core.EndpointParams",custom_edit_url:null},s=void 0,p={unversionedId:"interfaces/headstartwp_core.EndpointParams",id:"interfaces/headstartwp_core.EndpointParams",title:"Interface: EndpointParams",description:"@headstartwp/core.EndpointParams",source:"@site/docs/interfaces/headstartwp_core.EndpointParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.EndpointParams",permalink:"/docs/api/interfaces/headstartwp_core.EndpointParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.EndpointParams",title:"Interface: EndpointParams",sidebar_label:"@headstartwp/core.EndpointParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.CommentEntity",permalink:"/docs/api/interfaces/headstartwp_core.CommentEntity"},next:{title:"@headstartwp/core.Entity",permalink:"/docs/api/interfaces/headstartwp_core.Entity"}},o={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"lang",id:"lang",level:3},{value:"Defined in",id:"defined-in-2",level:4}],d={toc:l};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".EndpointParams"),(0,n.kt)("p",null,"The base interface for defining endpoint parameters"),(0,n.kt)("p",null,"Strategies should define type with the actually supported EndPointParams"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"EndpointParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"},(0,n.kt)("inlineCode",{parentName:"a"},"VerifyTokenParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams"))))),(0,n.kt)("h2",{id:"indexable"},"Indexable"),(0,n.kt)("p",null,"\u25aa ","[k: ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"_embed"},"_","embed"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"The _embed param returned associated entities in the response"),(0,n.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"_fields"},"_","fields"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"lang"},"lang"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"lang"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The polylang ?lang parameter."),(0,n.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9921],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>f});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function s(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),l=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):s(s({},t),e)),a},d=function(e){var t=l(e.components);return r.createElement(o.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),c=l(a),u=n,f=c["".concat(o,".").concat(u)]||c[u]||m[u]||i;return a?r.createElement(f,s(s({ref:t},d),{},{components:a})):r.createElement(f,s({ref:t},d))}));function f(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,s=new Array(i);s[0]=u;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[c]="string"==typeof e?e:n,s[1]=p;for(var l=2;l{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>s,default:()=>c,frontMatter:()=>i,metadata:()=>p,toc:()=>l});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.EndpointParams",title:"Interface: EndpointParams",sidebar_label:"@headstartwp/core.EndpointParams",custom_edit_url:null},s=void 0,p={unversionedId:"interfaces/headstartwp_core.EndpointParams",id:"interfaces/headstartwp_core.EndpointParams",title:"Interface: EndpointParams",description:"@headstartwp/core.EndpointParams",source:"@site/docs/interfaces/headstartwp_core.EndpointParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.EndpointParams",permalink:"/docs/api/interfaces/headstartwp_core.EndpointParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.EndpointParams",title:"Interface: EndpointParams",sidebar_label:"@headstartwp/core.EndpointParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.CommentEntity",permalink:"/docs/api/interfaces/headstartwp_core.CommentEntity"},next:{title:"@headstartwp/core.Entity",permalink:"/docs/api/interfaces/headstartwp_core.Entity"}},o={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"lang",id:"lang",level:3},{value:"Defined in",id:"defined-in-2",level:4}],d={toc:l};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".EndpointParams"),(0,n.kt)("p",null,"The base interface for defining endpoint parameters"),(0,n.kt)("p",null,"Strategies should define type with the actually supported EndPointParams"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"EndpointParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"},(0,n.kt)("inlineCode",{parentName:"a"},"VerifyTokenParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams"))))),(0,n.kt)("h2",{id:"indexable"},"Indexable"),(0,n.kt)("p",null,"\u25aa ","[k: ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"_embed"},"_","embed"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"The _embed param returned associated entities in the response"),(0,n.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"_fields"},"_","fields"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"lang"},"lang"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"lang"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The polylang ?lang parameter."),(0,n.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4bfc8e71.5cee6e5d.js b/assets/js/4bfc8e71.90d5ea45.js similarity index 98% rename from assets/js/4bfc8e71.5cee6e5d.js rename to assets/js/4bfc8e71.90d5ea45.js index d02b0c0f4..5c9e55805 100644 --- a/assets/js/4bfc8e71.5cee6e5d.js +++ b/assets/js/4bfc8e71.90d5ea45.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4015],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},u="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},g=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),u=p(n),g=a,m=u["".concat(s,".").concat(g)]||u[g]||c[g]||i;return n?r.createElement(m,o(o({ref:t},d),{},{components:n})):r.createElement(m,o({ref:t},d))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=g;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[u]="string"==typeof e?e:a,o[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>l,toc:()=>p});var r=n(7462),a=(n(7294),n(3905));const i={slug:"/getting-started/installing-wordpress-plugin",sidebar_position:4},o="Installing WordPress Plugin",l={unversionedId:"Getting Started/wordpress-plugin",id:"Getting Started/wordpress-plugin",title:"Installing WordPress Plugin",description:"Composer Installation (Recommended)",source:"@site/documentation/01-Getting Started/wordpress-plugin.md",sourceDirName:"01-Getting Started",slug:"/getting-started/installing-wordpress-plugin",permalink:"/docs/learn/getting-started/installing-wordpress-plugin",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/01-Getting Started/wordpress-plugin.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:4,frontMatter:{slug:"/getting-started/installing-wordpress-plugin",sidebar_position:4},sidebar:"tutorialSidebar",previous:{title:"Configuring the Framework",permalink:"/docs/learn/getting-started/headless-config"},next:{title:"Quick Introduction to the Framework",permalink:"/docs/learn/getting-started/quick-tutorial"}},s={},p=[{value:"Composer Installation (Recommended)",id:"composer-installation-recommended",level:2},{value:"Manual install",id:"manual-install",level:2},{value:"Enter the front-end site URL.",id:"enter-the-front-end-site-url",level:2}],d={toc:p};function u(e){let{components:t,...i}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,i,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"installing-wordpress-plugin"},"Installing WordPress Plugin"),(0,a.kt)("h2",{id:"composer-installation-recommended"},"Composer Installation (Recommended)"),(0,a.kt)("p",null,"The recommended method for installing this plugin is via composer: ",(0,a.kt)("inlineCode",{parentName:"p"},"composer require headstartwp/headstartwp"),"."),(0,a.kt)("p",null,"Make sure to set up the path for installing this as a WordPress Plugin:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-json"},'{\n "name": "your-vendor-name/your-project-name",\n "require": {\n "composer/installers": "^1.0",\n "headstartwp/headstartwp": "^1.0.0"\n },\n "extra": {\n "installer-paths": {\n "plugins/{$name}/": ["type:wordpress-plugin"]\n }\n },\n "config": {\n "allow-plugins": {\n "composer/installers": true\n }\n }\n}\n')),(0,a.kt)("h2",{id:"manual-install"},"Manual install"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp-plugin/archive/refs/heads/trunk.zip"},"Download the plugin's zip file"),", manually move it to ",(0,a.kt)("inlineCode",{parentName:"p"},"wp-content/plugins")," and activate the plugin."),(0,a.kt)("h2",{id:"enter-the-front-end-site-url"},"Enter the front-end site URL."),(0,a.kt)("p",null,"Go to ",(0,a.kt)("inlineCode",{parentName:"p"},"Settings -> General"),' and scroll down until you find the "Headless Frontend URL" and enter the URL for the Headless site.'),(0,a.kt)("p",null,(0,a.kt)("img",{alt:"Plugin settings",src:n(7607).Z,width:"835",height:"270"})))}u.isMDXComponent=!0},7607:(e,t,n)=>{n.d(t,{Z:()=>r});const r=n.p+"assets/images/plugin-settings-cd21201c2690c652abab12a4be1b0e31.png"}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4015],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},u="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},g=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),u=p(n),g=a,m=u["".concat(s,".").concat(g)]||u[g]||c[g]||i;return n?r.createElement(m,o(o({ref:t},d),{},{components:n})):r.createElement(m,o({ref:t},d))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=g;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[u]="string"==typeof e?e:a,o[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>l,toc:()=>p});var r=n(7462),a=(n(7294),n(3905));const i={slug:"/getting-started/installing-wordpress-plugin",sidebar_position:4},o="Installing WordPress Plugin",l={unversionedId:"Getting Started/wordpress-plugin",id:"Getting Started/wordpress-plugin",title:"Installing WordPress Plugin",description:"Composer Installation (Recommended)",source:"@site/documentation/01-Getting Started/wordpress-plugin.md",sourceDirName:"01-Getting Started",slug:"/getting-started/installing-wordpress-plugin",permalink:"/docs/learn/getting-started/installing-wordpress-plugin",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/01-Getting Started/wordpress-plugin.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:4,frontMatter:{slug:"/getting-started/installing-wordpress-plugin",sidebar_position:4},sidebar:"tutorialSidebar",previous:{title:"Configuring the Framework",permalink:"/docs/learn/getting-started/headless-config"},next:{title:"Quick Introduction to the Framework",permalink:"/docs/learn/getting-started/quick-tutorial"}},s={},p=[{value:"Composer Installation (Recommended)",id:"composer-installation-recommended",level:2},{value:"Manual install",id:"manual-install",level:2},{value:"Enter the front-end site URL.",id:"enter-the-front-end-site-url",level:2}],d={toc:p};function u(e){let{components:t,...i}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,i,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"installing-wordpress-plugin"},"Installing WordPress Plugin"),(0,a.kt)("h2",{id:"composer-installation-recommended"},"Composer Installation (Recommended)"),(0,a.kt)("p",null,"The recommended method for installing this plugin is via composer: ",(0,a.kt)("inlineCode",{parentName:"p"},"composer require headstartwp/headstartwp"),"."),(0,a.kt)("p",null,"Make sure to set up the path for installing this as a WordPress Plugin:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-json"},'{\n "name": "your-vendor-name/your-project-name",\n "require": {\n "composer/installers": "^1.0",\n "headstartwp/headstartwp": "^1.0.0"\n },\n "extra": {\n "installer-paths": {\n "plugins/{$name}/": ["type:wordpress-plugin"]\n }\n },\n "config": {\n "allow-plugins": {\n "composer/installers": true\n }\n }\n}\n')),(0,a.kt)("h2",{id:"manual-install"},"Manual install"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp-plugin/archive/refs/heads/trunk.zip"},"Download the plugin's zip file"),", manually move it to ",(0,a.kt)("inlineCode",{parentName:"p"},"wp-content/plugins")," and activate the plugin."),(0,a.kt)("h2",{id:"enter-the-front-end-site-url"},"Enter the front-end site URL."),(0,a.kt)("p",null,"Go to ",(0,a.kt)("inlineCode",{parentName:"p"},"Settings -> General"),' and scroll down until you find the "Headless Frontend URL" and enter the URL for the Headless site.'),(0,a.kt)("p",null,(0,a.kt)("img",{alt:"Plugin settings",src:n(7607).Z,width:"835",height:"270"})))}u.isMDXComponent=!0},7607:(e,t,n)=>{n.d(t,{Z:()=>r});const r=n.p+"assets/images/plugin-settings-cd21201c2690c652abab12a4be1b0e31.png"}}]); \ No newline at end of file diff --git a/assets/js/4c2ded29.2f53ad25.js b/assets/js/4c2ded29.fa6e5012.js similarity index 96% rename from assets/js/4c2ded29.2f53ad25.js rename to assets/js/4c2ded29.fa6e5012.js index 6d6083549..bcb65fa1e 100644 --- a/assets/js/4c2ded29.2f53ad25.js +++ b/assets/js/4c2ded29.fa6e5012.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3955],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var d=r.createContext({}),s=function(e){var t=r.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},o=function(e){var t=s(e.components);return r.createElement(d.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,o=p(e,["components","mdxType","originalType","parentName"]),m=s(a),c=n,h=m["".concat(d,".").concat(c)]||m[c]||k[c]||i;return a?r.createElement(h,l(l({ref:t},o),{},{components:a})):r.createElement(h,l({ref:t},o))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=c;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p[m]="string"==typeof e?e:n,l[1]=p;for(var s=2;s{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>m,frontMatter:()=>i,metadata:()=>p,toc:()=>s});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.AbstractFetchStrategy",title:"Class: AbstractFetchStrategy",sidebar_label:"@headstartwp/core.AbstractFetchStrategy",custom_edit_url:null},l=void 0,p={unversionedId:"classes/headstartwp_core.AbstractFetchStrategy",id:"classes/headstartwp_core.AbstractFetchStrategy",title:"Class: AbstractFetchStrategy",description:"@headstartwp/core.AbstractFetchStrategy",source:"@site/docs/classes/headstartwp_core.AbstractFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.AbstractFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AbstractFetchStrategy",title:"Class: AbstractFetchStrategy",sidebar_label:"@headstartwp/core.AbstractFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.LOGTYPE",permalink:"/docs/api/enums/headstartwp_core.LOGTYPE"},next:{title:"@headstartwp/core.AppSettingsStrategy",permalink:"/docs/api/classes/headstartwp_core.AppSettingsStrategy"}},d={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-19",level:4}],o={toc:s};function m(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AbstractFetchStrategy"),(0,n.kt)("p",null,"Abstract class that lays out a strategy for fetching data"),(0,n.kt)("p",null,"All Fetch Strategies should implement this class and it allows to share logic for fetching data both\non the front-end and on the back-end."),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The type of entity that is fetched (e.g PostEntity, TermEntity etc)")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Params")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,n.kt)("td",{parentName:"tr",align:"left"},"The type of the params that are passed to the endpoint")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"R")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E")),(0,n.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"AbstractFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"SinglePostFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AppSettingsStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AppSettingsStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyTermsStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"VerifyTokenFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new AbstractFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"E"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Params")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"R")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E"))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L115"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:115")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L105"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:105")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L110"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:110")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Builds the final endpoint URL based on the passed parameters"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to add to the request")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The endpoint URL."),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L206"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:206")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("p",null,"The default fetcher function"),(0,n.kt)("p",null,"The default fetcher function handles authentication headers and errors from the API."),(0,n.kt)("p",null,"A custom strategy can override this function to run additional logic before or after the fetch call"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetcher options")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L261"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:261")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L339"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:339")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L404"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:404")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L227"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:227")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L369"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:369")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("inlineCode",{parentName:"p"},"Abstract")," ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L121"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:121")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L168"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:168")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("inlineCode",{parentName:"p"},"Abstract")," ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L183"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:183")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"E"),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L327"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L191"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:191")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L379"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:379")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"E"),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L219"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:219")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L150"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:150")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L146"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:146")))}m.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3955],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var d=r.createContext({}),s=function(e){var t=r.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},o=function(e){var t=s(e.components);return r.createElement(d.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,o=p(e,["components","mdxType","originalType","parentName"]),m=s(a),c=n,h=m["".concat(d,".").concat(c)]||m[c]||k[c]||i;return a?r.createElement(h,l(l({ref:t},o),{},{components:a})):r.createElement(h,l({ref:t},o))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=c;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p[m]="string"==typeof e?e:n,l[1]=p;for(var s=2;s{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>m,frontMatter:()=>i,metadata:()=>p,toc:()=>s});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.AbstractFetchStrategy",title:"Class: AbstractFetchStrategy",sidebar_label:"@headstartwp/core.AbstractFetchStrategy",custom_edit_url:null},l=void 0,p={unversionedId:"classes/headstartwp_core.AbstractFetchStrategy",id:"classes/headstartwp_core.AbstractFetchStrategy",title:"Class: AbstractFetchStrategy",description:"@headstartwp/core.AbstractFetchStrategy",source:"@site/docs/classes/headstartwp_core.AbstractFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.AbstractFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AbstractFetchStrategy",title:"Class: AbstractFetchStrategy",sidebar_label:"@headstartwp/core.AbstractFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.LOGTYPE",permalink:"/docs/api/enums/headstartwp_core.LOGTYPE"},next:{title:"@headstartwp/core.AppSettingsStrategy",permalink:"/docs/api/classes/headstartwp_core.AppSettingsStrategy"}},d={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-19",level:4}],o={toc:s};function m(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AbstractFetchStrategy"),(0,n.kt)("p",null,"Abstract class that lays out a strategy for fetching data"),(0,n.kt)("p",null,"All Fetch Strategies should implement this class and it allows to share logic for fetching data both\non the front-end and on the back-end."),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The type of entity that is fetched (e.g PostEntity, TermEntity etc)")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Params")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,n.kt)("td",{parentName:"tr",align:"left"},"The type of the params that are passed to the endpoint")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"R")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E")),(0,n.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"AbstractFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"SinglePostFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AppSettingsStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AppSettingsStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyTermsStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"VerifyTokenFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new AbstractFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"E"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Params")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"R")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E"))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L115"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:115")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L105"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:105")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L110"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:110")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Builds the final endpoint URL based on the passed parameters"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to add to the request")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The endpoint URL."),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L206"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:206")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("p",null,"The default fetcher function"),(0,n.kt)("p",null,"The default fetcher function handles authentication headers and errors from the API."),(0,n.kt)("p",null,"A custom strategy can override this function to run additional logic before or after the fetch call"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetcher options")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L261"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:261")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L339"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:339")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L404"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:404")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L227"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:227")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L369"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:369")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("inlineCode",{parentName:"p"},"Abstract")," ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L121"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:121")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L168"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:168")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("inlineCode",{parentName:"p"},"Abstract")," ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L183"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:183")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"E"),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L327"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L191"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:191")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L379"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:379")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"E"),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L219"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:219")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L150"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:150")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L146"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:146")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4e3c32b5.e9a74569.js b/assets/js/4e3c32b5.f32d8808.js similarity index 99% rename from assets/js/4e3c32b5.e9a74569.js rename to assets/js/4e3c32b5.f32d8808.js index 0bc10669a..e641077bc 100644 --- a/assets/js/4e3c32b5.e9a74569.js +++ b/assets/js/4e3c32b5.f32d8808.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9530],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>m});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),l=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},c=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,p=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=l(n),h=r,m=d["".concat(p,".").concat(h)]||d[h]||u[h]||o;return n?a.createElement(m,i(i({ref:t},c),{},{components:n})):a.createElement(m,i({ref:t},c))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,i=new Array(o);i[0]=h;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[d]="string"==typeof e?e:r,i[1]=s;for(var l=2;l{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var a=n(7462),r=(n(7294),n(3905));const o={slug:"/data-fetching/usepost",sidebar_position:1},i="The usePost hook",s={unversionedId:"Data Fetching/usePost",id:"Data Fetching/usePost",title:"The usePost hook",description:"The usePost hook is the Next.js binding for the useFetchPost.",source:"@site/documentation/02 - Data Fetching/usePost.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/usepost",permalink:"/docs/learn/data-fetching/usepost",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/usePost.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:1,frontMatter:{slug:"/data-fetching/usepost",sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Introduction",permalink:"/docs/learn/data-fetching"},next:{title:"The usePosts hook",permalink:"/docs/learn/data-fetching/useposts"}},p={},l=[{value:"Basic Usage",id:"basic-usage",level:2},{value:"Post path matching",id:"post-path-matching",level:4},{value:"Fetching from multiple post types",id:"fetching-from-multiple-post-types",level:3},{value:"Fetching from a custom post type",id:"fetching-from-a-custom-post-type",level:2}],c={toc:l};function d(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"the-usepost-hook"},"The usePost hook"),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"The ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#usepost"},"usePost")," hook is the Next.js binding for the ",(0,r.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchpost"},"useFetchPost"),".")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," hook fetches a single WordPress post from a registered post type. Its basic usage is very simple."),(0,r.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,r.kt)("p",null,"The basic usage is pretty simple and it assumes a route named ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/[...path].js")," where the ",(0,r.kt)("inlineCode",{parentName:"p"},"slug")," is extracted from the URL."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/[...path].js",title:"src/pages/[...path].js"},"import { usePost } from '@headstartwp/next';\n\nconst PostPage = () => {\n const { loading, error, data } = usePost();\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n

{data?.post.title.rendered}

\n
\n );\n};\n")),(0,r.kt)("h4",{id:"post-path-matching"},"Post path matching"),(0,r.kt)("admonition",{type:"caution"},(0,r.kt)("p",{parentName:"admonition"},"The behavior described here was implemented in version ",(0,r.kt)("strong",{parentName:"p"},"0.5.x")," of the framework and can be disabled by passing ",(0,r.kt)("inlineCode",{parentName:"p"},"matchCurrentPath: false")," to ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," (and ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData")," for server-side data fetching).")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," hook will by default match the current path captured by ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," with the post's link property. This ensures the right post is loaded and that 404 are issued to unsupported permalinks. "),(0,r.kt)("admonition",{type:"caution"},(0,r.kt)("p",{parentName:"admonition"},"The framework requires that the permalink structure set on the backend matches the URL structure being used on the front-end. "),(0,r.kt)("p",{parentName:"admonition"},"This means that if you include the date in your permalinks the URLs to a post without the date will 404 in the framework."),(0,r.kt)("p",{parentName:"admonition"},"This is also true for custom post types, if the WordPress backend expects a custom post type to be at ",(0,r.kt)("inlineCode",{parentName:"p"},"/book/book-name")," the front-end must also follow the same URL structure. If you wish to change the permalink structure for custom post types make sure to make the changes both in WordPress and in your front-end code.")),(0,r.kt)("p",null,"Example where path matches:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"User visits URL ",(0,r.kt)("inlineCode",{parentName:"li"},"/post-name")),(0,r.kt)("li",{parentName:"ul"},"The post with the ",(0,r.kt)("inlineCode",{parentName:"li"},"post-name")," slug contains a ",(0,r.kt)("inlineCode",{parentName:"li"},"http://backend.com/post-name")," link."),(0,r.kt)("li",{parentName:"ul"},"Since the URL and the path of ",(0,r.kt)("inlineCode",{parentName:"li"},"post.link")," matches the page/post is rendered.")),(0,r.kt)("p",null,"Example where path does not match:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"User visits URL ",(0,r.kt)("inlineCode",{parentName:"li"},"/parent-page/post-name")),(0,r.kt)("li",{parentName:"ul"},"The post with the ",(0,r.kt)("inlineCode",{parentName:"li"},"post-name")," slug contains a ",(0,r.kt)("inlineCode",{parentName:"li"},"http://backend.com/different-parent/post-name")," url"),(0,r.kt)("li",{parentName:"ul"},"Since the URL (",(0,r.kt)("inlineCode",{parentName:"li"},"/parent-page/post-name"),") and the path of ",(0,r.kt)("inlineCode",{parentName:"li"},"post.link")," (",(0,r.kt)("inlineCode",{parentName:"li"},"different-parent/post-name"),") ",(0,r.kt)("strong",{parentName:"li"},"do not")," match a 404 page is issued.")),(0,r.kt)("p",null,"Example where path does not match but is redirected to the right one:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"User visits URL ",(0,r.kt)("inlineCode",{parentName:"li"},"/post-name")),(0,r.kt)("li",{parentName:"ul"},"The post with the ",(0,r.kt)("inlineCode",{parentName:"li"},"post-name")," slug contains a ",(0,r.kt)("inlineCode",{parentName:"li"},"http://backend.com/2022/10/30/post-name")," url"),(0,r.kt)("li",{parentName:"ul"},"Since the URL and the path of ",(0,r.kt)("inlineCode",{parentName:"li"},"post.link")," do not match, a NotFound error is thrown"),(0,r.kt)("li",{parentName:"ul"},"If prefetching is setup following ",(0,r.kt)("a",{parentName:"li",href:"/learn/data-fetching/prefetching"},"pre-fetching")," and ",(0,r.kt)("inlineCode",{parentName:"li"},"redirectStrategy"),' is set to "404" or "always" in ',(0,r.kt)("inlineCode",{parentName:"li"},"headstartwp.config.js"),", ",(0,r.kt)("inlineCode",{parentName:"li"},"handleError")," will then look if there's a redirect available and since WordPress redirects ",(0,r.kt)("inlineCode",{parentName:"li"},"/post-name")," to ",(0,r.kt)("inlineCode",{parentName:"li"},"/2022/10/30/post-name"),", the framework will also perform the redirect.")),(0,r.kt)("h3",{id:"fetching-from-multiple-post-types"},"Fetching from multiple post types"),(0,r.kt)("p",null,"When specifying an array of post type, the slug will be searched in both endpoint and the first one to return a valid post object will be used."),(0,r.kt)("admonition",{type:"caution"},(0,r.kt)("p",{parentName:"admonition"},"This might result in URL conflicts, i.e a post or page using the same slug. The first post type specified will take precedence. In such cases, consider using a different URL structure for each for instance (e.g: using ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/article/[...path].js")," for posts).")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"import { usePost } from '@headstartwp/next';\n\nconst PostOrPage = () => {\n const { loading, error, data } = usePost({ postType: ['page', 'post'] });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n

{data?.post.title.rendered}

\n
\n );\n};\n")),(0,r.kt)("h2",{id:"fetching-from-a-custom-post-type"},"Fetching from a custom post type"),(0,r.kt)("p",null,"To fetch a single from a custom post type, first declare the custom post type in ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," as explained in the ",(0,r.kt)("a",{parentName:"p",href:"/learn/getting-started/headless-config#custom-post-types"},"headstartwp.config.js")," section."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/book/[...path].js"',title:'"src/pages/book/[...path].js"'},"import { usePost } from '@headstartwp/next';\n\nconst PostPage = () => {\n const { loading, error, data } = usePost({ postType: 'book' });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n

{data?.post.title.rendered}

\n
\n );\n};\n")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9530],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>m});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),l=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},c=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,p=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=l(n),h=r,m=d["".concat(p,".").concat(h)]||d[h]||u[h]||o;return n?a.createElement(m,i(i({ref:t},c),{},{components:n})):a.createElement(m,i({ref:t},c))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,i=new Array(o);i[0]=h;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[d]="string"==typeof e?e:r,i[1]=s;for(var l=2;l{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var a=n(7462),r=(n(7294),n(3905));const o={slug:"/data-fetching/usepost",sidebar_position:1},i="The usePost hook",s={unversionedId:"Data Fetching/usePost",id:"Data Fetching/usePost",title:"The usePost hook",description:"The usePost hook is the Next.js binding for the useFetchPost.",source:"@site/documentation/02 - Data Fetching/usePost.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/usepost",permalink:"/docs/learn/data-fetching/usepost",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/usePost.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:1,frontMatter:{slug:"/data-fetching/usepost",sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Introduction",permalink:"/docs/learn/data-fetching"},next:{title:"The usePosts hook",permalink:"/docs/learn/data-fetching/useposts"}},p={},l=[{value:"Basic Usage",id:"basic-usage",level:2},{value:"Post path matching",id:"post-path-matching",level:4},{value:"Fetching from multiple post types",id:"fetching-from-multiple-post-types",level:3},{value:"Fetching from a custom post type",id:"fetching-from-a-custom-post-type",level:2}],c={toc:l};function d(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"the-usepost-hook"},"The usePost hook"),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"The ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#usepost"},"usePost")," hook is the Next.js binding for the ",(0,r.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchpost"},"useFetchPost"),".")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," hook fetches a single WordPress post from a registered post type. Its basic usage is very simple."),(0,r.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,r.kt)("p",null,"The basic usage is pretty simple and it assumes a route named ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/[...path].js")," where the ",(0,r.kt)("inlineCode",{parentName:"p"},"slug")," is extracted from the URL."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/[...path].js",title:"src/pages/[...path].js"},"import { usePost } from '@headstartwp/next';\n\nconst PostPage = () => {\n const { loading, error, data } = usePost();\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n

{data?.post.title.rendered}

\n
\n );\n};\n")),(0,r.kt)("h4",{id:"post-path-matching"},"Post path matching"),(0,r.kt)("admonition",{type:"caution"},(0,r.kt)("p",{parentName:"admonition"},"The behavior described here was implemented in version ",(0,r.kt)("strong",{parentName:"p"},"0.5.x")," of the framework and can be disabled by passing ",(0,r.kt)("inlineCode",{parentName:"p"},"matchCurrentPath: false")," to ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," (and ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData")," for server-side data fetching).")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," hook will by default match the current path captured by ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," with the post's link property. This ensures the right post is loaded and that 404 are issued to unsupported permalinks. "),(0,r.kt)("admonition",{type:"caution"},(0,r.kt)("p",{parentName:"admonition"},"The framework requires that the permalink structure set on the backend matches the URL structure being used on the front-end. "),(0,r.kt)("p",{parentName:"admonition"},"This means that if you include the date in your permalinks the URLs to a post without the date will 404 in the framework."),(0,r.kt)("p",{parentName:"admonition"},"This is also true for custom post types, if the WordPress backend expects a custom post type to be at ",(0,r.kt)("inlineCode",{parentName:"p"},"/book/book-name")," the front-end must also follow the same URL structure. If you wish to change the permalink structure for custom post types make sure to make the changes both in WordPress and in your front-end code.")),(0,r.kt)("p",null,"Example where path matches:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"User visits URL ",(0,r.kt)("inlineCode",{parentName:"li"},"/post-name")),(0,r.kt)("li",{parentName:"ul"},"The post with the ",(0,r.kt)("inlineCode",{parentName:"li"},"post-name")," slug contains a ",(0,r.kt)("inlineCode",{parentName:"li"},"http://backend.com/post-name")," link."),(0,r.kt)("li",{parentName:"ul"},"Since the URL and the path of ",(0,r.kt)("inlineCode",{parentName:"li"},"post.link")," matches the page/post is rendered.")),(0,r.kt)("p",null,"Example where path does not match:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"User visits URL ",(0,r.kt)("inlineCode",{parentName:"li"},"/parent-page/post-name")),(0,r.kt)("li",{parentName:"ul"},"The post with the ",(0,r.kt)("inlineCode",{parentName:"li"},"post-name")," slug contains a ",(0,r.kt)("inlineCode",{parentName:"li"},"http://backend.com/different-parent/post-name")," url"),(0,r.kt)("li",{parentName:"ul"},"Since the URL (",(0,r.kt)("inlineCode",{parentName:"li"},"/parent-page/post-name"),") and the path of ",(0,r.kt)("inlineCode",{parentName:"li"},"post.link")," (",(0,r.kt)("inlineCode",{parentName:"li"},"different-parent/post-name"),") ",(0,r.kt)("strong",{parentName:"li"},"do not")," match a 404 page is issued.")),(0,r.kt)("p",null,"Example where path does not match but is redirected to the right one:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"User visits URL ",(0,r.kt)("inlineCode",{parentName:"li"},"/post-name")),(0,r.kt)("li",{parentName:"ul"},"The post with the ",(0,r.kt)("inlineCode",{parentName:"li"},"post-name")," slug contains a ",(0,r.kt)("inlineCode",{parentName:"li"},"http://backend.com/2022/10/30/post-name")," url"),(0,r.kt)("li",{parentName:"ul"},"Since the URL and the path of ",(0,r.kt)("inlineCode",{parentName:"li"},"post.link")," do not match, a NotFound error is thrown"),(0,r.kt)("li",{parentName:"ul"},"If prefetching is setup following ",(0,r.kt)("a",{parentName:"li",href:"/learn/data-fetching/prefetching"},"pre-fetching")," and ",(0,r.kt)("inlineCode",{parentName:"li"},"redirectStrategy"),' is set to "404" or "always" in ',(0,r.kt)("inlineCode",{parentName:"li"},"headstartwp.config.js"),", ",(0,r.kt)("inlineCode",{parentName:"li"},"handleError")," will then look if there's a redirect available and since WordPress redirects ",(0,r.kt)("inlineCode",{parentName:"li"},"/post-name")," to ",(0,r.kt)("inlineCode",{parentName:"li"},"/2022/10/30/post-name"),", the framework will also perform the redirect.")),(0,r.kt)("h3",{id:"fetching-from-multiple-post-types"},"Fetching from multiple post types"),(0,r.kt)("p",null,"When specifying an array of post type, the slug will be searched in both endpoint and the first one to return a valid post object will be used."),(0,r.kt)("admonition",{type:"caution"},(0,r.kt)("p",{parentName:"admonition"},"This might result in URL conflicts, i.e a post or page using the same slug. The first post type specified will take precedence. In such cases, consider using a different URL structure for each for instance (e.g: using ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/article/[...path].js")," for posts).")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"import { usePost } from '@headstartwp/next';\n\nconst PostOrPage = () => {\n const { loading, error, data } = usePost({ postType: ['page', 'post'] });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n

{data?.post.title.rendered}

\n
\n );\n};\n")),(0,r.kt)("h2",{id:"fetching-from-a-custom-post-type"},"Fetching from a custom post type"),(0,r.kt)("p",null,"To fetch a single from a custom post type, first declare the custom post type in ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," as explained in the ",(0,r.kt)("a",{parentName:"p",href:"/learn/getting-started/headless-config#custom-post-types"},"headstartwp.config.js")," section."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/book/[...path].js"',title:'"src/pages/book/[...path].js"'},"import { usePost } from '@headstartwp/next';\n\nconst PostPage = () => {\n const { loading, error, data } = usePost({ postType: 'book' });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n

{data?.post.title.rendered}

\n
\n );\n};\n")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4e62b870.93d0d02f.js b/assets/js/4e62b870.fafd8cea.js similarity index 96% rename from assets/js/4e62b870.93d0d02f.js rename to assets/js/4e62b870.fafd8cea.js index 37d13c123..5f92c906b 100644 --- a/assets/js/4e62b870.93d0d02f.js +++ b/assets/js/4e62b870.fafd8cea.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5700],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.IFileBlock",title:"Interface: IFileBlock",sidebar_label:"@headstartwp/core.react.IFileBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IFileBlock",id:"interfaces/headstartwp_core.react.IFileBlock",title:"Interface: IFileBlock",description:"@headstartwp/core.react.IFileBlock",source:"@site/docs/interfaces/headstartwp_core.react.IFileBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IFileBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IFileBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IFileBlock",title:"Interface: IFileBlock",sidebar_label:"@headstartwp/core.react.IFileBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IDataWPBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IDataWPBlock"},next:{title:"@headstartwp/core.react.IGroupBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IFileBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"FileBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IFileBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"FileBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"FileBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5700],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.IFileBlock",title:"Interface: IFileBlock",sidebar_label:"@headstartwp/core.react.IFileBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IFileBlock",id:"interfaces/headstartwp_core.react.IFileBlock",title:"Interface: IFileBlock",description:"@headstartwp/core.react.IFileBlock",source:"@site/docs/interfaces/headstartwp_core.react.IFileBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IFileBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IFileBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IFileBlock",title:"Interface: IFileBlock",sidebar_label:"@headstartwp/core.react.IFileBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IDataWPBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IDataWPBlock"},next:{title:"@headstartwp/core.react.IGroupBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IFileBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"FileBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IFileBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"FileBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"FileBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4e86766f.204b4194.js b/assets/js/4e86766f.d7880d47.js similarity index 96% rename from assets/js/4e86766f.204b4194.js rename to assets/js/4e86766f.d7880d47.js index e21304aa8..130b748a2 100644 --- a/assets/js/4e86766f.204b4194.js +++ b/assets/js/4e86766f.d7880d47.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6741],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function o(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),d=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},s=function(e){var t=d(e.components);return n.createElement(p.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,p=e.parentName,s=i(e,["components","mdxType","originalType","parentName"]),c=d(a),k=r,h=c["".concat(p,".").concat(k)]||c[k]||m[k]||l;return a?n.createElement(h,o(o({ref:t},s),{},{components:a})):n.createElement(h,o({ref:t},s))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,o=new Array(l);o[0]=k;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[c]="string"==typeof e?e:r,o[1]=i;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>c,frontMatter:()=>l,metadata:()=>i,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const l={id:"headstartwp_core.react.BlockProps",title:"Interface: BlockProps",sidebar_label:"@headstartwp/core.react.BlockProps",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.BlockProps",id:"interfaces/headstartwp_core.react.BlockProps",title:"Interface: BlockProps",description:"@headstartwp/core.react.BlockProps",source:"@site/docs/interfaces/headstartwp_core.react.BlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.BlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.BlockProps",title:"Interface: BlockProps",sidebar_label:"@headstartwp/core.react.BlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.BlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockAttributes"},next:{title:"@headstartwp/core.react.BlockRendererProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockRendererProps"}},p={},d=[{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"domNode",id:"domnode",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-3",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"tagName",id:"tagname",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"test",id:"test",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:d};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".BlockProps"),(0,r.kt)("p",null,"The interface any children of ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," must implement."),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("p",null,"The actual domNode that was replaced with the react component"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L46"},"packages/core/src/react/components/BlocksRenderer.tsx:46")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"test"},"test"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"test"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"A test function receives a domNode and returns a boolean value indicating\nwhether that domNode should be replaced with the React component"),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L19"},"packages/core/src/react/components/BlocksRenderer.tsx:19")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6741],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function o(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),d=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},s=function(e){var t=d(e.components);return n.createElement(p.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,p=e.parentName,s=i(e,["components","mdxType","originalType","parentName"]),c=d(a),k=r,h=c["".concat(p,".").concat(k)]||c[k]||m[k]||l;return a?n.createElement(h,o(o({ref:t},s),{},{components:a})):n.createElement(h,o({ref:t},s))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,o=new Array(l);o[0]=k;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[c]="string"==typeof e?e:r,o[1]=i;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>c,frontMatter:()=>l,metadata:()=>i,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const l={id:"headstartwp_core.react.BlockProps",title:"Interface: BlockProps",sidebar_label:"@headstartwp/core.react.BlockProps",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.BlockProps",id:"interfaces/headstartwp_core.react.BlockProps",title:"Interface: BlockProps",description:"@headstartwp/core.react.BlockProps",source:"@site/docs/interfaces/headstartwp_core.react.BlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.BlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.BlockProps",title:"Interface: BlockProps",sidebar_label:"@headstartwp/core.react.BlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.BlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockAttributes"},next:{title:"@headstartwp/core.react.BlockRendererProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockRendererProps"}},p={},d=[{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"domNode",id:"domnode",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-3",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"tagName",id:"tagname",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"test",id:"test",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:d};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".BlockProps"),(0,r.kt)("p",null,"The interface any children of ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," must implement."),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("p",null,"The actual domNode that was replaced with the react component"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L46"},"packages/core/src/react/components/BlocksRenderer.tsx:46")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"test"},"test"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"test"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"A test function receives a domNode and returns a boolean value indicating\nwhether that domNode should be replaced with the React component"),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L19"},"packages/core/src/react/components/BlocksRenderer.tsx:19")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/54355d51.da54fd73.js b/assets/js/54355d51.7d44666d.js similarity index 96% rename from assets/js/54355d51.da54fd73.js rename to assets/js/54355d51.7d44666d.js index 3546ce96d..3eee64b2b 100644 --- a/assets/js/54355d51.da54fd73.js +++ b/assets/js/54355d51.7d44666d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4409],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.IParagraphBlock",title:"Interface: IParagraphBlock",sidebar_label:"@headstartwp/core.react.IParagraphBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IParagraphBlock",id:"interfaces/headstartwp_core.react.IParagraphBlock",title:"Interface: IParagraphBlock",description:"@headstartwp/core.react.IParagraphBlock",source:"@site/docs/interfaces/headstartwp_core.react.IParagraphBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IParagraphBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IParagraphBlock",title:"Interface: IParagraphBlock",sidebar_label:"@headstartwp/core.react.IParagraphBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IMediaTextBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock"},next:{title:"@headstartwp/core.react.IPreformattedBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IParagraphBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ParagraphBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IParagraphBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ParagraphBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ParagraphBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4409],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.IParagraphBlock",title:"Interface: IParagraphBlock",sidebar_label:"@headstartwp/core.react.IParagraphBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IParagraphBlock",id:"interfaces/headstartwp_core.react.IParagraphBlock",title:"Interface: IParagraphBlock",description:"@headstartwp/core.react.IParagraphBlock",source:"@site/docs/interfaces/headstartwp_core.react.IParagraphBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IParagraphBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IParagraphBlock",title:"Interface: IParagraphBlock",sidebar_label:"@headstartwp/core.react.IParagraphBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IMediaTextBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock"},next:{title:"@headstartwp/core.react.IPreformattedBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IParagraphBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ParagraphBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IParagraphBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ParagraphBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ParagraphBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/54d19cbf.6ee5e421.js b/assets/js/54d19cbf.c3ab9b70.js similarity index 99% rename from assets/js/54d19cbf.6ee5e421.js rename to assets/js/54d19cbf.c3ab9b70.js index 249f5f220..8e7461a96 100644 --- a/assets/js/54d19cbf.6ee5e421.js +++ b/assets/js/54d19cbf.c3ab9b70.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[825],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>g});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=a.createContext({}),d=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=d(e.components);return a.createElement(l.Provider,{value:t},e.children)},u="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=d(n),h=i,g=u["".concat(l,".").concat(h)]||u[h]||c[h]||r;return n?a.createElement(g,o(o({ref:t},p),{},{components:n})):a.createElement(g,o({ref:t},p))}));function g(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,o=new Array(r);o[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[u]="string"==typeof e?e:i,o[1]=s;for(var d=2;d{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>d});var a=n(7462),i=(n(7294),n(3905));const r={sidebar_position:2,slug:"/wordpress-integration/revalidate"},o="On-demand ISR revalidation",s={unversionedId:"WordPress Integration/revalidate",id:"WordPress Integration/revalidate",title:"On-demand ISR revalidation",description:"On-demand Revalidation is the ability to revalidate static pages programmatically from the CMS.",source:"@site/documentation/06-WordPress Integration/revalidate.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/revalidate",permalink:"/docs/learn/wordpress-integration/revalidate",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/revalidate.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:2,frontMatter:{sidebar_position:2,slug:"/wordpress-integration/revalidate"},sidebar:"tutorialSidebar",previous:{title:"Multisite",permalink:"/docs/learn/wordpress-integration/multisite"},next:{title:"Basic Auth",permalink:"/docs/learn/wordpress-integration/basic-auth"}},l={},d=[{value:"Usage",id:"usage",level:2},{value:"Plugin setup",id:"plugin-setup",level:3},{value:"Revalidate Endpoint",id:"revalidate-endpoint",level:3},{value:"How does it work?",id:"how-does-it-work",level:2},{value:"Supporting Next.js ISR outside of Vercel",id:"supporting-nextjs-isr-outside-of-vercel",level:2},{value:"@10up/next-redis-cache-provider",id:"10upnext-redis-cache-provider",level:3},{value:"Purging the CDN Cache",id:"purging-the-cdn-cache",level:3},{value:"A note about WordPress VIP",id:"a-note-about-wordpress-vip",level:4},{value:"Revalidating in a Cron Job",id:"revalidating-in-a-cron-job",level:3}],p={toc:d};function u(e){let{components:t,...r}=e;return(0,i.kt)("wrapper",(0,a.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"on-demand-isr-revalidation"},"On-demand ISR revalidation"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/basic-features/data-fetching/incremental-static-regeneration#on-demand-revalidation"},"On-demand Revalidation")," is the ability to revalidate static pages programmatically from the CMS."),(0,i.kt)("p",null,"Without On-demand ISR revalidation users will need to wait until the time set in the ",(0,i.kt)("inlineCode",{parentName:"p"},"revalidate")," prop has passed before they can see an updated version of that page. This means that if a ",(0,i.kt)("inlineCode",{parentName:"p"},"revalidate")," is set to 5min, users would potentially have to wait up to 5min before they can see new content."),(0,i.kt)("p",null,'It is preferred to have the CMS ask the Next.js app to revalidate those pages when possible. This can be done via "On-Demand Revalidation".'),(0,i.kt)("p",null,"HeadstartWP supports Next.js ISR via the WordPress plugin and via ",(0,i.kt)("inlineCode",{parentName:"p"},"@10up/next-redis-cache-provider")," for hosts that do not natively support Next.js ISR (e.g. VIP, WPEngine etc)."),(0,i.kt)("h2",{id:"usage"},"Usage"),(0,i.kt)("h3",{id:"plugin-setup"},"Plugin setup"),(0,i.kt)("p",null,"HeadstartWP supports On-Demand Revalidation and it requires installing the WordPress Plugin. On-Demand Revalidation is opt-in and must be manually enabled in the plugin's settings (Settings -> General).\n",(0,i.kt)("img",{alt:"Plugin settings",src:n(7607).Z,width:"835",height:"270"})),(0,i.kt)("p",null,"The plugin expects the revalidate endpoint to live at ",(0,i.kt)("inlineCode",{parentName:"p"},"/api/revalidate"),". It is possible to customize this endpoint via the ",(0,i.kt)("inlineCode",{parentName:"p"},"tenup_headless_isr_revalidate_endpoint"),"."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filters the revalidate endpoint.\n *\n * @param string $revalidate_endpoint The revalidate endpoint\n */\n$revalidate_endpoint = apply_filters( \n 'tenup_headless_isr_revalidate_endpoint', \n trailingslashit( Plugin::get_react_url() ) . 'api/revalidate' \n);\n")),(0,i.kt)("h3",{id:"revalidate-endpoint"},"Revalidate Endpoint"),(0,i.kt)("p",null,"Simply create a Next.js API endpoint that uses the ",(0,i.kt)("inlineCode",{parentName:"p"},"revalidateHandler")," provided by the framework. "),(0,i.kt)("admonition",{type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"If you changed the default value of the endpoint path via the ",(0,i.kt)("inlineCode",{parentName:"p"},"tenup_headless_isr_revalidate_endpoint")," filter, make sure you change it in the Next.js app as well. ")),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-javascript",metastring:'title="src/pages/api/revalidate"',title:'"src/pages/api/revalidate"'},"import { revalidateHandler } from '@headstartwp/next';\n\n/**\n * The revalidate endpoint just needs to proxy the default revalidate handler\n *\n * @param {*} req Next.js request object\n * @param {*} res Next.js response object\n *\n * @returns\n */\nexport default async function handler(req, res) {\n return revalidateHandler(req, res);\n}\n")),(0,i.kt)("h2",{id:"how-does-it-work"},"How does it work?"),(0,i.kt)("p",null,"The default implementation will revalidate any post or page upon saving in WordPress. You can see the logic ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/develop/wp/headless-wp/includes/classes/CacheFlush/CacheFlush.php#L40"},"here"),"."),(0,i.kt)("h2",{id:"supporting-nextjs-isr-outside-of-vercel"},"Supporting Next.js ISR outside of Vercel"),(0,i.kt)("p",null,"If your host does not support Next.js ISR natively (e.g. WordPress VIP, WPEngine etc), ISR won't work well. If your hosting is serving your app via a traditional non-serverless setup using docker/kubernetes you most likely will run into issues trying to leverage Next.js ISR."),(0,i.kt)("p",null,"First off, if multiple containers are running to serve the requests to your website, a call to revalidate a particular page will only ever hit one of the containers that are running. This will lead to users being served by the containers that weren't hit by the WP call to still serve the old page. Even worse, the same user might be served by different containers and get both old and new responses for a page (e.g. the initial HTML is updated but the JSON associated with the page isn't)."),(0,i.kt)("p",null,"Officially, Next.js ",(0,i.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/pages/building-your-application/data-fetching/incremental-static-regeneration#self-hosting-isr"},"recommends")," sharing a writable volume across all the containers but that has some performance implications and some hosts simply don't support this setup."),(0,i.kt)("h3",{id:"10upnext-redis-cache-provider"},"@10up/next-redis-cache-provider"),(0,i.kt)("admonition",{type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"If you are hosting on Vercel you do not need this package.")),(0,i.kt)("p",null,"Our solution to this problem has been to replace the filesystem cache with a redis cache provider. So whenever Next.js revalidates a page instead of storing the static page in disk, it will write to a shared redis instance that all of the containers would be talking to. The diagram below exemplifies how it works."),(0,i.kt)("p",null,(0,i.kt)("img",{alt:"Plugin settings",src:n(5218).Z,width:"2318",height:"819"})),(0,i.kt)("p",null,"To set up ",(0,i.kt)("inlineCode",{parentName:"p"},"@10up/next-redis-cache-provider")," first install it via npm:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-bash"},"npm install --save @10up/next-redis-cache-provider\n")),(0,i.kt)("p",null,"Then add it in ",(0,i.kt)("inlineCode",{parentName:"p"},"next.config.js"),":"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="next.config.js"',title:'"next.config.js"'},"const { withHeadstartWPConfig } = require('@headstartwp/next/config');\n\n/**\n * Update whatever you need within the nextConfig object.\n *\n * @type {import('next').NextConfig}\n */\nconst nextConfig = {\n eslint: {\n ignoreDuringBuilds: true,\n },\n};\n\n\nif (process.env.NEXT_REDIS_URL || process.env.VIP_REDIS_PRIMARY) {\n // eslint-disable-next-line global-require\n const { initRedisClient } = require('@10up/next-redis-cache-provider');\n initRedisClient();\n nextConfig.experimental = {\n incrementalCacheHandlerPath: require.resolve('@10up/next-redis-cache-provider'),\n };\n}\n\nmodule.exports = withHeadstartWPConfig(nextConfig);\n")),(0,i.kt)("admonition",{type:"info"},(0,i.kt)("p",{parentName:"admonition"},"The HeadstartWP ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/tree/develop/projects/wp-nextjs"},"scaffold")," already includes the code above")),(0,i.kt)("p",null,"The code above checks for ",(0,i.kt)("inlineCode",{parentName:"p"},"NEXT_REDIS_URL")," and ",(0,i.kt)("inlineCode",{parentName:"p"},"VIP_REDIS_PRIMARY")," (which is specific for WordPress VIP hosting), however there are several other env variables you can use to configure your redis connection."),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_URL"),": It's the simplest way to set up your redis connection, simply pass the full redis connection string."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"VIP_REDIS_PRIMARY")," and ",(0,i.kt)("inlineCode",{parentName:"li"},"VIP_REDIS_PASSWORD"),": this is specific to WordPress VIP hosting, if Redis is enabled on VIP hosting these env variables will be automatically set for you so you do not need to add them yourself."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_HOST"),", ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_PORT")," and ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_PASS"),": Instead of a full redis connection string you can specify the host, port and password separately."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_SENTINEL_NAME"),", ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_SENTINEL_PASSWORD"),", ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_PASS"),": This is only needed if you want to connect to a redis sentinel cluster. If you do so, you also need to set the ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_HOST"),", ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_PORT")," and ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_PASS")," variables.")),(0,i.kt)("h3",{id:"purging-the-cdn-cache"},"Purging the CDN Cache"),(0,i.kt)("p",null,"Another thing you want to consider is flushing the CDN cache ",(0,i.kt)("strong",{parentName:"p"},"after")," you revalidate the page in Next.js. This can be done on the WordPress side by hooking up to the ",(0,i.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_revalidate")," action. This action is fired off after Next.js has finished revalidating the page."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-php"},"add_filter( 'tenup_headless_wp_revalidate', function( $post, $front_end_post_url ) {\n // $front_end_psot_url is the URL for the post with the front-end/headless url.\n function_to_clear_my_favorite_cdn_cache( $front_end_post_url );\n}, 10, 2 );\n")),(0,i.kt)("h4",{id:"a-note-about-wordpress-vip"},"A note about WordPress VIP"),(0,i.kt)("p",null,"If you are hosting on WordPress VIP the plugin already clears the VIP CDN cache, so you don't need to handle this yourself. The ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/develop/wp/headless-wp/includes/classes/CacheFlush/CacheFlush.php#L122C6-L122C6"},"following code")," is included in the plugin:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-php"},"if ( 200 === (int) $status_code && function_exists( 'wpcom_vip_purge_edge_cache_for_url' ) ) {\n wpcom_vip_purge_edge_cache_for_url( $headless_post_url );\n}\n")),(0,i.kt)("h3",{id:"revalidating-in-a-cron-job"},"Revalidating in a Cron Job"),(0,i.kt)("p",null,"If you prefer to run the revalidation logic in the background, you can tell the plugin to schedule a one-off cron job for immediate execution every time a post is saved. This can be enabled with the ",(0,i.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_revalidate_on_cron")," filter (it defaults to false)."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-php"},"add_filter( 'tenup_headless_wp_revalidate_on_cron', '___return_true' );\n")),(0,i.kt)("p",null,"This can be useful when the revalidation or the CDN cache purge is slow sp this can be used to speed up the post saving process."))}u.isMDXComponent=!0},7607:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/plugin-settings-cd21201c2690c652abab12a4be1b0e31.png"},5218:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/next-redis-cache-provider-fd13dd0eb17e43a3cd567dac08b80cd9.png"}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[825],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>g});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=a.createContext({}),d=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=d(e.components);return a.createElement(l.Provider,{value:t},e.children)},u="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=d(n),h=i,g=u["".concat(l,".").concat(h)]||u[h]||c[h]||r;return n?a.createElement(g,o(o({ref:t},p),{},{components:n})):a.createElement(g,o({ref:t},p))}));function g(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,o=new Array(r);o[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[u]="string"==typeof e?e:i,o[1]=s;for(var d=2;d{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>d});var a=n(7462),i=(n(7294),n(3905));const r={sidebar_position:2,slug:"/wordpress-integration/revalidate"},o="On-demand ISR revalidation",s={unversionedId:"WordPress Integration/revalidate",id:"WordPress Integration/revalidate",title:"On-demand ISR revalidation",description:"On-demand Revalidation is the ability to revalidate static pages programmatically from the CMS.",source:"@site/documentation/06-WordPress Integration/revalidate.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/revalidate",permalink:"/docs/learn/wordpress-integration/revalidate",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/revalidate.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:2,frontMatter:{sidebar_position:2,slug:"/wordpress-integration/revalidate"},sidebar:"tutorialSidebar",previous:{title:"Multisite",permalink:"/docs/learn/wordpress-integration/multisite"},next:{title:"Basic Auth",permalink:"/docs/learn/wordpress-integration/basic-auth"}},l={},d=[{value:"Usage",id:"usage",level:2},{value:"Plugin setup",id:"plugin-setup",level:3},{value:"Revalidate Endpoint",id:"revalidate-endpoint",level:3},{value:"How does it work?",id:"how-does-it-work",level:2},{value:"Supporting Next.js ISR outside of Vercel",id:"supporting-nextjs-isr-outside-of-vercel",level:2},{value:"@10up/next-redis-cache-provider",id:"10upnext-redis-cache-provider",level:3},{value:"Purging the CDN Cache",id:"purging-the-cdn-cache",level:3},{value:"A note about WordPress VIP",id:"a-note-about-wordpress-vip",level:4},{value:"Revalidating in a Cron Job",id:"revalidating-in-a-cron-job",level:3}],p={toc:d};function u(e){let{components:t,...r}=e;return(0,i.kt)("wrapper",(0,a.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"on-demand-isr-revalidation"},"On-demand ISR revalidation"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/basic-features/data-fetching/incremental-static-regeneration#on-demand-revalidation"},"On-demand Revalidation")," is the ability to revalidate static pages programmatically from the CMS."),(0,i.kt)("p",null,"Without On-demand ISR revalidation users will need to wait until the time set in the ",(0,i.kt)("inlineCode",{parentName:"p"},"revalidate")," prop has passed before they can see an updated version of that page. This means that if a ",(0,i.kt)("inlineCode",{parentName:"p"},"revalidate")," is set to 5min, users would potentially have to wait up to 5min before they can see new content."),(0,i.kt)("p",null,'It is preferred to have the CMS ask the Next.js app to revalidate those pages when possible. This can be done via "On-Demand Revalidation".'),(0,i.kt)("p",null,"HeadstartWP supports Next.js ISR via the WordPress plugin and via ",(0,i.kt)("inlineCode",{parentName:"p"},"@10up/next-redis-cache-provider")," for hosts that do not natively support Next.js ISR (e.g. VIP, WPEngine etc)."),(0,i.kt)("h2",{id:"usage"},"Usage"),(0,i.kt)("h3",{id:"plugin-setup"},"Plugin setup"),(0,i.kt)("p",null,"HeadstartWP supports On-Demand Revalidation and it requires installing the WordPress Plugin. On-Demand Revalidation is opt-in and must be manually enabled in the plugin's settings (Settings -> General).\n",(0,i.kt)("img",{alt:"Plugin settings",src:n(7607).Z,width:"835",height:"270"})),(0,i.kt)("p",null,"The plugin expects the revalidate endpoint to live at ",(0,i.kt)("inlineCode",{parentName:"p"},"/api/revalidate"),". It is possible to customize this endpoint via the ",(0,i.kt)("inlineCode",{parentName:"p"},"tenup_headless_isr_revalidate_endpoint"),"."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filters the revalidate endpoint.\n *\n * @param string $revalidate_endpoint The revalidate endpoint\n */\n$revalidate_endpoint = apply_filters( \n 'tenup_headless_isr_revalidate_endpoint', \n trailingslashit( Plugin::get_react_url() ) . 'api/revalidate' \n);\n")),(0,i.kt)("h3",{id:"revalidate-endpoint"},"Revalidate Endpoint"),(0,i.kt)("p",null,"Simply create a Next.js API endpoint that uses the ",(0,i.kt)("inlineCode",{parentName:"p"},"revalidateHandler")," provided by the framework. "),(0,i.kt)("admonition",{type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"If you changed the default value of the endpoint path via the ",(0,i.kt)("inlineCode",{parentName:"p"},"tenup_headless_isr_revalidate_endpoint")," filter, make sure you change it in the Next.js app as well. ")),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-javascript",metastring:'title="src/pages/api/revalidate"',title:'"src/pages/api/revalidate"'},"import { revalidateHandler } from '@headstartwp/next';\n\n/**\n * The revalidate endpoint just needs to proxy the default revalidate handler\n *\n * @param {*} req Next.js request object\n * @param {*} res Next.js response object\n *\n * @returns\n */\nexport default async function handler(req, res) {\n return revalidateHandler(req, res);\n}\n")),(0,i.kt)("h2",{id:"how-does-it-work"},"How does it work?"),(0,i.kt)("p",null,"The default implementation will revalidate any post or page upon saving in WordPress. You can see the logic ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/develop/wp/headless-wp/includes/classes/CacheFlush/CacheFlush.php#L40"},"here"),"."),(0,i.kt)("h2",{id:"supporting-nextjs-isr-outside-of-vercel"},"Supporting Next.js ISR outside of Vercel"),(0,i.kt)("p",null,"If your host does not support Next.js ISR natively (e.g. WordPress VIP, WPEngine etc), ISR won't work well. If your hosting is serving your app via a traditional non-serverless setup using docker/kubernetes you most likely will run into issues trying to leverage Next.js ISR."),(0,i.kt)("p",null,"First off, if multiple containers are running to serve the requests to your website, a call to revalidate a particular page will only ever hit one of the containers that are running. This will lead to users being served by the containers that weren't hit by the WP call to still serve the old page. Even worse, the same user might be served by different containers and get both old and new responses for a page (e.g. the initial HTML is updated but the JSON associated with the page isn't)."),(0,i.kt)("p",null,"Officially, Next.js ",(0,i.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/pages/building-your-application/data-fetching/incremental-static-regeneration#self-hosting-isr"},"recommends")," sharing a writable volume across all the containers but that has some performance implications and some hosts simply don't support this setup."),(0,i.kt)("h3",{id:"10upnext-redis-cache-provider"},"@10up/next-redis-cache-provider"),(0,i.kt)("admonition",{type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"If you are hosting on Vercel you do not need this package.")),(0,i.kt)("p",null,"Our solution to this problem has been to replace the filesystem cache with a redis cache provider. So whenever Next.js revalidates a page instead of storing the static page in disk, it will write to a shared redis instance that all of the containers would be talking to. The diagram below exemplifies how it works."),(0,i.kt)("p",null,(0,i.kt)("img",{alt:"Plugin settings",src:n(5218).Z,width:"2318",height:"819"})),(0,i.kt)("p",null,"To set up ",(0,i.kt)("inlineCode",{parentName:"p"},"@10up/next-redis-cache-provider")," first install it via npm:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-bash"},"npm install --save @10up/next-redis-cache-provider\n")),(0,i.kt)("p",null,"Then add it in ",(0,i.kt)("inlineCode",{parentName:"p"},"next.config.js"),":"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="next.config.js"',title:'"next.config.js"'},"const { withHeadstartWPConfig } = require('@headstartwp/next/config');\n\n/**\n * Update whatever you need within the nextConfig object.\n *\n * @type {import('next').NextConfig}\n */\nconst nextConfig = {\n eslint: {\n ignoreDuringBuilds: true,\n },\n};\n\n\nif (process.env.NEXT_REDIS_URL || process.env.VIP_REDIS_PRIMARY) {\n // eslint-disable-next-line global-require\n const { initRedisClient } = require('@10up/next-redis-cache-provider');\n initRedisClient();\n nextConfig.experimental = {\n incrementalCacheHandlerPath: require.resolve('@10up/next-redis-cache-provider'),\n };\n}\n\nmodule.exports = withHeadstartWPConfig(nextConfig);\n")),(0,i.kt)("admonition",{type:"info"},(0,i.kt)("p",{parentName:"admonition"},"The HeadstartWP ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/tree/develop/projects/wp-nextjs"},"scaffold")," already includes the code above")),(0,i.kt)("p",null,"The code above checks for ",(0,i.kt)("inlineCode",{parentName:"p"},"NEXT_REDIS_URL")," and ",(0,i.kt)("inlineCode",{parentName:"p"},"VIP_REDIS_PRIMARY")," (which is specific for WordPress VIP hosting), however there are several other env variables you can use to configure your redis connection."),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_URL"),": It's the simplest way to set up your redis connection, simply pass the full redis connection string."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"VIP_REDIS_PRIMARY")," and ",(0,i.kt)("inlineCode",{parentName:"li"},"VIP_REDIS_PASSWORD"),": this is specific to WordPress VIP hosting, if Redis is enabled on VIP hosting these env variables will be automatically set for you so you do not need to add them yourself."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_HOST"),", ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_PORT")," and ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_PASS"),": Instead of a full redis connection string you can specify the host, port and password separately."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_SENTINEL_NAME"),", ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_SENTINEL_PASSWORD"),", ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_PASS"),": This is only needed if you want to connect to a redis sentinel cluster. If you do so, you also need to set the ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_HOST"),", ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_PORT")," and ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_PASS")," variables.")),(0,i.kt)("h3",{id:"purging-the-cdn-cache"},"Purging the CDN Cache"),(0,i.kt)("p",null,"Another thing you want to consider is flushing the CDN cache ",(0,i.kt)("strong",{parentName:"p"},"after")," you revalidate the page in Next.js. This can be done on the WordPress side by hooking up to the ",(0,i.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_revalidate")," action. This action is fired off after Next.js has finished revalidating the page."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-php"},"add_filter( 'tenup_headless_wp_revalidate', function( $post, $front_end_post_url ) {\n // $front_end_psot_url is the URL for the post with the front-end/headless url.\n function_to_clear_my_favorite_cdn_cache( $front_end_post_url );\n}, 10, 2 );\n")),(0,i.kt)("h4",{id:"a-note-about-wordpress-vip"},"A note about WordPress VIP"),(0,i.kt)("p",null,"If you are hosting on WordPress VIP the plugin already clears the VIP CDN cache, so you don't need to handle this yourself. The ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/develop/wp/headless-wp/includes/classes/CacheFlush/CacheFlush.php#L122C6-L122C6"},"following code")," is included in the plugin:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-php"},"if ( 200 === (int) $status_code && function_exists( 'wpcom_vip_purge_edge_cache_for_url' ) ) {\n wpcom_vip_purge_edge_cache_for_url( $headless_post_url );\n}\n")),(0,i.kt)("h3",{id:"revalidating-in-a-cron-job"},"Revalidating in a Cron Job"),(0,i.kt)("p",null,"If you prefer to run the revalidation logic in the background, you can tell the plugin to schedule a one-off cron job for immediate execution every time a post is saved. This can be enabled with the ",(0,i.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_revalidate_on_cron")," filter (it defaults to false)."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-php"},"add_filter( 'tenup_headless_wp_revalidate_on_cron', '___return_true' );\n")),(0,i.kt)("p",null,"This can be useful when the revalidation or the CDN cache purge is slow sp this can be used to speed up the post saving process."))}u.isMDXComponent=!0},7607:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/plugin-settings-cd21201c2690c652abab12a4be1b0e31.png"},5218:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/next-redis-cache-provider-fd13dd0eb17e43a3cd567dac08b80cd9.png"}}]); \ No newline at end of file diff --git a/assets/js/55dad7f7.e5682b04.js b/assets/js/55dad7f7.c09dd4db.js similarity index 99% rename from assets/js/55dad7f7.e5682b04.js rename to assets/js/55dad7f7.c09dd4db.js index 95e307f8d..de42af666 100644 --- a/assets/js/55dad7f7.e5682b04.js +++ b/assets/js/55dad7f7.c09dd4db.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3586],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>h});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),p=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=p(e.components);return n.createElement(l.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=p(r),m=a,h=d["".concat(l,".").concat(m)]||d[m]||u[m]||o;return r?n.createElement(h,i(i({ref:t},c),{},{components:r})):n.createElement(h,i({ref:t},c))}));function h(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[d]="string"==typeof e?e:a,i[1]=s;for(var p=2;p{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const o={slug:"/utilities/sanitization",sidebar_label:"Escaping & Sanitization"},i="Escaping & Sanitization",s={unversionedId:"Utilities/sanitization",id:"Utilities/sanitization",title:"Escaping & Sanitization",description:"As you're probably aware, React won't render raw HTML by default. If you want to do so you must use dangerouslySetInnerHTML.",source:"@site/documentation/03- Utilities/sanitization.md",sourceDirName:"03- Utilities",slug:"/utilities/sanitization",permalink:"/docs/learn/utilities/sanitization",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/03- Utilities/sanitization.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{slug:"/utilities/sanitization",sidebar_label:"Escaping & Sanitization"},sidebar:"tutorialSidebar",previous:{title:"Prefetching data on the server",permalink:"/docs/learn/data-fetching/prefetching"},next:{title:"Rendering Blocks",permalink:"/docs/learn/gutenberg/rendering-blocks"}},l={},p=[{value:"wpKsesPost",id:"wpksespost",level:2},{value:"stripTags",id:"striptags",level:2},{value:"BlocksRenderer",id:"blocksrenderer",level:2},{value:"HtmlDecoder",id:"htmldecoder",level:2},{value:"SafeHtml",id:"safehtml",level:2},{value:"decodeHtmlSpeciaChars",id:"decodehtmlspeciachars",level:2}],c={toc:p};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"escaping--sanitization"},"Escaping & Sanitization"),(0,a.kt)("p",null,"As you're probably aware, React won't render raw HTML by default. If you want to do so you must use ",(0,a.kt)("a",{parentName:"p",href:"https://react.dev/reference/react-dom/components/common#dangerously-setting-the-inner-html"},"dangerouslySetInnerHTML"),"."),(0,a.kt)("p",null,"This page describes some of the utility functions and components provided by the framework to help with escaping & sanitization when rendering raw markup."),(0,a.kt)("h2",{id:"wpksespost"},"wpKsesPost"),(0,a.kt)("p",null,"This function sanitizes HTML content with requirements similar to ",(0,a.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/reference/functions/wp_kses_post/"},"wp_kses_post"),". If you are rendering arbitrary HTML markup you should probably run the markup through this function first."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},"import { wpKsesPost } from '@headstartwp/core';\n\nconst markup = { __html: wpKsesPost('

some raw html

') };\nreturn
;\n")),(0,a.kt)("h2",{id:"striptags"},"stripTags"),(0,a.kt)("p",null,"This function simply strips any html tags from a string. This can be useful in contexts where you don't want any HTML to be rendered."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},"import { stripTags } from '@headstartwp/core';\n\nreturn

{stripTags('this is a title without a span')}

;\n")),(0,a.kt)("h2",{id:"blocksrenderer"},"BlocksRenderer"),(0,a.kt)("p",null,"When using ",(0,a.kt)("a",{parentName:"p",href:"/learn/gutenberg/rendering-blocks"},"BlocksRenderer")," your markup already goes through ",(0,a.kt)("inlineCode",{parentName:"p"},"wpKsesPost")," so there's nothing else you need to worry about."),(0,a.kt)("h2",{id:"htmldecoder"},"HtmlDecoder"),(0,a.kt)("p",null,"Sometimes you might just want to decode some HTML entities without actually rendering any HTML tags. For this purpose you can use the ",(0,a.kt)("inlineCode",{parentName:"p"},"HtmlDecoder")," component."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},"import { HtmlDecoder } from '@headstartwp/core/react';\n\n

\n \n

\n")),(0,a.kt)("h2",{id:"safehtml"},"SafeHtml"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"SafeHtml")," component provides an easy way to safely render HTML markup. It runs the markup through ",(0,a.kt)("inlineCode",{parentName:"p"},"wpKsesPost")," just like ",(0,a.kt)("inlineCode",{parentName:"p"},"BlocksRenderer"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},"import { SafeHtml } from '@headstartwp/core/react';\n\n

hello world

div content
\">\n")),(0,a.kt)("h2",{id:"decodehtmlspeciachars"},"decodeHtmlSpeciaChars"),(0,a.kt)("p",null,"This function will decode a pre-defined set of html special chars."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"import { decodeHtmlSpeciaChars } from '@headstartwp/core';\n\ndecodeHtmlSpeciaChars('Hello world! – foo bar –');\n")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3586],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>h});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),p=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=p(e.components);return n.createElement(l.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=p(r),m=a,h=d["".concat(l,".").concat(m)]||d[m]||u[m]||o;return r?n.createElement(h,i(i({ref:t},c),{},{components:r})):n.createElement(h,i({ref:t},c))}));function h(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[d]="string"==typeof e?e:a,i[1]=s;for(var p=2;p{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const o={slug:"/utilities/sanitization",sidebar_label:"Escaping & Sanitization"},i="Escaping & Sanitization",s={unversionedId:"Utilities/sanitization",id:"Utilities/sanitization",title:"Escaping & Sanitization",description:"As you're probably aware, React won't render raw HTML by default. If you want to do so you must use dangerouslySetInnerHTML.",source:"@site/documentation/03- Utilities/sanitization.md",sourceDirName:"03- Utilities",slug:"/utilities/sanitization",permalink:"/docs/learn/utilities/sanitization",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/03- Utilities/sanitization.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{slug:"/utilities/sanitization",sidebar_label:"Escaping & Sanitization"},sidebar:"tutorialSidebar",previous:{title:"Prefetching data on the server",permalink:"/docs/learn/data-fetching/prefetching"},next:{title:"Rendering Blocks",permalink:"/docs/learn/gutenberg/rendering-blocks"}},l={},p=[{value:"wpKsesPost",id:"wpksespost",level:2},{value:"stripTags",id:"striptags",level:2},{value:"BlocksRenderer",id:"blocksrenderer",level:2},{value:"HtmlDecoder",id:"htmldecoder",level:2},{value:"SafeHtml",id:"safehtml",level:2},{value:"decodeHtmlSpeciaChars",id:"decodehtmlspeciachars",level:2}],c={toc:p};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"escaping--sanitization"},"Escaping & Sanitization"),(0,a.kt)("p",null,"As you're probably aware, React won't render raw HTML by default. If you want to do so you must use ",(0,a.kt)("a",{parentName:"p",href:"https://react.dev/reference/react-dom/components/common#dangerously-setting-the-inner-html"},"dangerouslySetInnerHTML"),"."),(0,a.kt)("p",null,"This page describes some of the utility functions and components provided by the framework to help with escaping & sanitization when rendering raw markup."),(0,a.kt)("h2",{id:"wpksespost"},"wpKsesPost"),(0,a.kt)("p",null,"This function sanitizes HTML content with requirements similar to ",(0,a.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/reference/functions/wp_kses_post/"},"wp_kses_post"),". If you are rendering arbitrary HTML markup you should probably run the markup through this function first."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},"import { wpKsesPost } from '@headstartwp/core';\n\nconst markup = { __html: wpKsesPost('

some raw html

') };\nreturn
;\n")),(0,a.kt)("h2",{id:"striptags"},"stripTags"),(0,a.kt)("p",null,"This function simply strips any html tags from a string. This can be useful in contexts where you don't want any HTML to be rendered."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},"import { stripTags } from '@headstartwp/core';\n\nreturn

{stripTags('this is a title without a span')}

;\n")),(0,a.kt)("h2",{id:"blocksrenderer"},"BlocksRenderer"),(0,a.kt)("p",null,"When using ",(0,a.kt)("a",{parentName:"p",href:"/learn/gutenberg/rendering-blocks"},"BlocksRenderer")," your markup already goes through ",(0,a.kt)("inlineCode",{parentName:"p"},"wpKsesPost")," so there's nothing else you need to worry about."),(0,a.kt)("h2",{id:"htmldecoder"},"HtmlDecoder"),(0,a.kt)("p",null,"Sometimes you might just want to decode some HTML entities without actually rendering any HTML tags. For this purpose you can use the ",(0,a.kt)("inlineCode",{parentName:"p"},"HtmlDecoder")," component."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},"import { HtmlDecoder } from '@headstartwp/core/react';\n\n

\n \n

\n")),(0,a.kt)("h2",{id:"safehtml"},"SafeHtml"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"SafeHtml")," component provides an easy way to safely render HTML markup. It runs the markup through ",(0,a.kt)("inlineCode",{parentName:"p"},"wpKsesPost")," just like ",(0,a.kt)("inlineCode",{parentName:"p"},"BlocksRenderer"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},"import { SafeHtml } from '@headstartwp/core/react';\n\n

hello world

div content
\">\n")),(0,a.kt)("h2",{id:"decodehtmlspeciachars"},"decodeHtmlSpeciaChars"),(0,a.kt)("p",null,"This function will decode a pre-defined set of html special chars."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"import { decodeHtmlSpeciaChars } from '@headstartwp/core';\n\ndecodeHtmlSpeciaChars('Hello world! – foo bar –');\n")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/560f4e5a.7d2b0ad2.js b/assets/js/560f4e5a.ce124df2.js similarity index 99% rename from assets/js/560f4e5a.7d2b0ad2.js rename to assets/js/560f4e5a.ce124df2.js index 0fbe6b9af..eb754b033 100644 --- a/assets/js/560f4e5a.7d2b0ad2.js +++ b/assets/js/560f4e5a.ce124df2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8247],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>u});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var d=n.createContext({}),p=function(e){var t=n.useContext(d),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return n.createElement(d.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),c=p(r),m=a,u=c["".concat(d,".").concat(m)]||c[m]||k[m]||i;return r?n.createElement(u,l(l({ref:t},s),{},{components:r})):n.createElement(u,l({ref:t},s))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=m;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o[c]="string"==typeof e?e:a,l[1]=o;for(var p=2;p{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const i={id:"headstartwp_core.ConfigError",title:"Class: ConfigError",sidebar_label:"@headstartwp/core.ConfigError",custom_edit_url:null},l=void 0,o={unversionedId:"classes/headstartwp_core.ConfigError",id:"classes/headstartwp_core.ConfigError",title:"Class: ConfigError",description:"@headstartwp/core.ConfigError",source:"@site/docs/classes/headstartwp_core.ConfigError.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.ConfigError",permalink:"/docs/api/classes/headstartwp_core.ConfigError",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.ConfigError",title:"Class: ConfigError",sidebar_label:"@headstartwp/core.ConfigError",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Comment",permalink:"/docs/api/classes/headstartwp_core.Comment"},next:{title:"@headstartwp/core.Element",permalink:"/docs/api/classes/headstartwp_core.Element"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"cause",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"stack",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"prepareStackTrace",id:"preparestacktrace",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:p};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".ConfigError"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"Error")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"ConfigError"))))),(0,a.kt)("h2",{id:"constructors"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new ConfigError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"message"),")"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"Error.constructor"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/errors.ts#L18"},"packages/core/src/utils/errors.ts:18")),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"cause"},"cause"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"cause"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"Error.cause"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"message"},"message"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"message"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"Error.message"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1054"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"Error.name"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1053"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stack"},"stack"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"stack"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"Error.stack"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1055"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:127"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"preparestacktrace"},"prepareStackTrace"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"prepareStackTrace"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"CallSite"),"[]) => ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("p",null,"Optional override for formatting stack traces"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"See"))),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces"},"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces")),(0,a.kt)("h5",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"err")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Error"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"stackTraces")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"CallSite"),"[]")))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"Error.prepareStackTrace"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:140"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stacktracelimit"},"stackTraceLimit"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"stackTraceLimit"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"Error.stackTraceLimit"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:142"),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"capturestacktrace"},"captureStackTrace"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"captureStackTrace"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"targetObject"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"constructorOpt?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"Create .stack property on a target object"),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"targetObject")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Object"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"constructorOpt?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Function"))))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,"Error.captureStackTrace"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:133"))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8247],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>u});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var d=n.createContext({}),p=function(e){var t=n.useContext(d),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return n.createElement(d.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),c=p(r),m=a,u=c["".concat(d,".").concat(m)]||c[m]||k[m]||i;return r?n.createElement(u,l(l({ref:t},s),{},{components:r})):n.createElement(u,l({ref:t},s))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=m;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o[c]="string"==typeof e?e:a,l[1]=o;for(var p=2;p{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const i={id:"headstartwp_core.ConfigError",title:"Class: ConfigError",sidebar_label:"@headstartwp/core.ConfigError",custom_edit_url:null},l=void 0,o={unversionedId:"classes/headstartwp_core.ConfigError",id:"classes/headstartwp_core.ConfigError",title:"Class: ConfigError",description:"@headstartwp/core.ConfigError",source:"@site/docs/classes/headstartwp_core.ConfigError.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.ConfigError",permalink:"/docs/api/classes/headstartwp_core.ConfigError",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.ConfigError",title:"Class: ConfigError",sidebar_label:"@headstartwp/core.ConfigError",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Comment",permalink:"/docs/api/classes/headstartwp_core.Comment"},next:{title:"@headstartwp/core.Element",permalink:"/docs/api/classes/headstartwp_core.Element"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"cause",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"stack",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"prepareStackTrace",id:"preparestacktrace",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:p};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".ConfigError"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"Error")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"ConfigError"))))),(0,a.kt)("h2",{id:"constructors"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new ConfigError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"message"),")"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"Error.constructor"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/errors.ts#L18"},"packages/core/src/utils/errors.ts:18")),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"cause"},"cause"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"cause"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"Error.cause"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"message"},"message"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"message"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"Error.message"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1054"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"Error.name"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1053"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stack"},"stack"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"stack"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"Error.stack"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1055"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:127"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"preparestacktrace"},"prepareStackTrace"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"prepareStackTrace"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"CallSite"),"[]) => ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("p",null,"Optional override for formatting stack traces"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"See"))),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces"},"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces")),(0,a.kt)("h5",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"err")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Error"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"stackTraces")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"CallSite"),"[]")))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"Error.prepareStackTrace"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:140"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stacktracelimit"},"stackTraceLimit"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"stackTraceLimit"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"Error.stackTraceLimit"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:142"),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"capturestacktrace"},"captureStackTrace"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"captureStackTrace"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"targetObject"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"constructorOpt?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"Create .stack property on a target object"),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"targetObject")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Object"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"constructorOpt?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Function"))))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,"Error.captureStackTrace"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:133"))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5667ca25.d309bce8.js b/assets/js/5667ca25.390b42a1.js similarity index 92% rename from assets/js/5667ca25.d309bce8.js rename to assets/js/5667ca25.390b42a1.js index 91c7049d7..acea69797 100644 --- a/assets/js/5667ca25.d309bce8.js +++ b/assets/js/5667ca25.390b42a1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1994],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var s=n.createContext({}),l=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),c=l(a),m=i,k=c["".concat(s,".").concat(m)]||c[m]||h[m]||r;return a?n.createElement(k,p(p({ref:t},o),{},{components:a})):n.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=a.length,p=new Array(r);p[0]=m;var d={};for(var s in t)hasOwnProperty.call(t,s)&&(d[s]=t[s]);d.originalType=e,d[c]="string"==typeof e?e:i,p[1]=d;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var n=a(7462),i=(a(7294),a(3905));const r={id:"headstartwp_core.AttachmentEntity",title:"Interface: AttachmentEntity",sidebar_label:"@headstartwp/core.AttachmentEntity",custom_edit_url:null},p=void 0,d={unversionedId:"interfaces/headstartwp_core.AttachmentEntity",id:"interfaces/headstartwp_core.AttachmentEntity",title:"Interface: AttachmentEntity",description:"@headstartwp/core.AttachmentEntity",source:"@site/docs/interfaces/headstartwp_core.AttachmentEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.AttachmentEntity",permalink:"/docs/api/interfaces/headstartwp_core.AttachmentEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AttachmentEntity",title:"Interface: AttachmentEntity",sidebar_label:"@headstartwp/core.AttachmentEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AppEntity",permalink:"/docs/api/interfaces/headstartwp_core.AppEntity"},next:{title:"@headstartwp/core.AuthorEntity",permalink:"/docs/api/interfaces/headstartwp_core.AuthorEntity"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"alt_text",id:"alt_text",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"author",id:"author",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"caption",id:"caption",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"comment_status",id:"comment_status",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"date",id:"date",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"guid",id:"guid",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"link",id:"link",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"media_details",id:"media_details",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"media_type",id:"media_type",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"mime_type",id:"mime_type",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"missing_image_sizes",id:"missing_image_sizes",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"modified",id:"modified",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"modified_gmt",id:"modified_gmt",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"ping_status",id:"ping_status",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"post",id:"post",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"slug",id:"slug",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"source_url",id:"source_url",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"status",id:"status",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"template",id:"template",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"terms",id:"terms",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-28",level:4}],o={toc:l};function c(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AttachmentEntity"),(0,i.kt)("p",null,"Interface for entities from the /wp/v2/media endpoint."),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PostTypeEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"AttachmentEntity"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"_embedded"},"_","embedded"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"author")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wp:term")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]")))),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#_embedded"},"_embedded")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L98"},"packages/core/src/data/types/entities.ts:98")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"alt_text"},"alt","_","text"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"alt","_","text"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Alternative text to display when attachment is not displayed."),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L259"},"packages/core/src/data/types/entities.ts:259")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"author"},"author"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"author"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#author"},"author")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L94"},"packages/core/src/data/types/entities.ts:94")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"caption"},"caption"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"caption"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The attachment caption."),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L264"},"packages/core/src/data/types/entities.ts:264")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"comment_status"},"comment","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"comment","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not comments are open on the object."),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#comment_status"},"comment_status")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L106"},"packages/core/src/data/types/entities.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date"},"date"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date"},"date")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L42"},"packages/core/src/data/types/entities.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, as GMT."),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date_gmt"},"date_gmt")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L47"},"packages/core/src/data/types/entities.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"description"},"description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"description"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The attachment description."),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L269"},"packages/core/src/data/types/entities.ts:269")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"guid"},"guid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"guid"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The globally unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#guid"},"guid")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L52"},"packages/core/src/data/types/entities.ts:52")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#id"},"id")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L67"},"packages/core/src/data/types/entities.ts:67")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"link"},"link"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"link"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the object."),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#link"},"link")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L72"},"packages/core/src/data/types/entities.ts:72")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"media_details"},"media","_","details"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"media","_","details"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("p",null,"Details about the media file, specific to its type."),(0,i.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"file")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The file path relative to ",(0,i.kt)("inlineCode",{parentName:"td"},"wp-content/uploads"),".")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"height")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The height of the attachment.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"image_meta")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"unknown"),">"),(0,i.kt)("td",{parentName:"tr",align:"left"},"The metadata of the attachment.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"sizes")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),", { ",(0,i.kt)("inlineCode",{parentName:"td"},"file"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"height"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"mime_type"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"source_url"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"width"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"number")," }",">"),(0,i.kt)("td",{parentName:"tr",align:"left"},"The different sizes that WordPress created for this attachment.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"width")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The width of the attachment.")))),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L284"},"packages/core/src/data/types/entities.ts:284")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"media_type"},"media","_","type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"media","_","type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"image"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"file"')),(0,i.kt)("p",null,"Attachment type."),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L274"},"packages/core/src/data/types/entities.ts:274")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"meta"},"meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"meta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("p",null,"Meta fields."),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L249"},"packages/core/src/data/types/entities.ts:249")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"mime_type"},"mime","_","type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"mime","_","type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The attachment MIME type."),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L279"},"packages/core/src/data/types/entities.ts:279")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"missing_image_sizes"},"missing","_","image","_","sizes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"missing","_","image","_","sizes"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,i.kt)("p",null,"List of the missing image sizes of the attachment."),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L352"},"packages/core/src/data/types/entities.ts:352")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified"},"modified"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified"},"modified")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L57"},"packages/core/src/data/types/entities.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified_gmt"},"modified","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, as GMT."),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified_gmt"},"modified_gmt")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L62"},"packages/core/src/data/types/entities.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ping_status"},"ping","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ping","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not the object can be pinged."),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#ping_status"},"ping_status")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L111"},"packages/core/src/data/types/entities.ts:111")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"post"},"post"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"post"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The ID for the associated post of the attachment."),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L342"},"packages/core/src/data/types/entities.ts:342")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"slug"},"slug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"slug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"An alphanumeric identifier for the object unique to its type."),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#slug"},"slug")),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L77"},"packages/core/src/data/types/entities.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"source_url"},"source","_","url"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"source","_","url"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the original attachment file."),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L347"},"packages/core/src/data/types/entities.ts:347")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"private"')),(0,i.kt)("p",null,"A named status for the object."),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#status"},"status")),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L82"},"packages/core/src/data/types/entities.ts:82")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"template"},"template"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"template"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The theme file to use to display the object."),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L254"},"packages/core/src/data/types/entities.ts:254")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"terms"},"terms"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"terms"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#terms"},"terms")),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L96"},"packages/core/src/data/types/entities.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The title for the object."),(0,i.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#title"},"title")),(0,i.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L92"},"packages/core/src/data/types/entities.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"attachment"')),(0,i.kt)("p",null,"Type of Post for the object."),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#type"},"type")),(0,i.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L244"},"packages/core/src/data/types/entities.ts:244")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head"},"yoast_head")),(0,i.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L114"},"packages/core/src/data/types/entities.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head_json"},"yoast_head_json")),(0,i.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L113"},"packages/core/src/data/types/entities.ts:113")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1994],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var s=n.createContext({}),l=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},h="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),h=l(a),m=i,k=h["".concat(s,".").concat(m)]||h[m]||c[m]||r;return a?n.createElement(k,p(p({ref:t},o),{},{components:a})):n.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=a.length,p=new Array(r);p[0]=m;var d={};for(var s in t)hasOwnProperty.call(t,s)&&(d[s]=t[s]);d.originalType=e,d[h]="string"==typeof e?e:i,p[1]=d;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var n=a(7462),i=(a(7294),a(3905));const r={id:"headstartwp_core.AttachmentEntity",title:"Interface: AttachmentEntity",sidebar_label:"@headstartwp/core.AttachmentEntity",custom_edit_url:null},p=void 0,d={unversionedId:"interfaces/headstartwp_core.AttachmentEntity",id:"interfaces/headstartwp_core.AttachmentEntity",title:"Interface: AttachmentEntity",description:"@headstartwp/core.AttachmentEntity",source:"@site/docs/interfaces/headstartwp_core.AttachmentEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.AttachmentEntity",permalink:"/docs/api/interfaces/headstartwp_core.AttachmentEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AttachmentEntity",title:"Interface: AttachmentEntity",sidebar_label:"@headstartwp/core.AttachmentEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AppEntity",permalink:"/docs/api/interfaces/headstartwp_core.AppEntity"},next:{title:"@headstartwp/core.AuthorEntity",permalink:"/docs/api/interfaces/headstartwp_core.AuthorEntity"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"alt_text",id:"alt_text",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"author",id:"author",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"caption",id:"caption",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"comment_status",id:"comment_status",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"date",id:"date",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"guid",id:"guid",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"link",id:"link",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"media_details",id:"media_details",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"media_type",id:"media_type",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"mime_type",id:"mime_type",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"missing_image_sizes",id:"missing_image_sizes",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"modified",id:"modified",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"modified_gmt",id:"modified_gmt",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"ping_status",id:"ping_status",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"post",id:"post",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"slug",id:"slug",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"source_url",id:"source_url",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"status",id:"status",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"template",id:"template",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"terms",id:"terms",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-28",level:4}],o={toc:l};function h(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AttachmentEntity"),(0,i.kt)("p",null,"Interface for entities from the /wp/v2/media endpoint."),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PostTypeEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"AttachmentEntity"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"_embedded"},"_","embedded"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"author")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wp:term")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]")))),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#_embedded"},"_embedded")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L98"},"packages/core/src/data/types/entities.ts:98")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"alt_text"},"alt","_","text"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"alt","_","text"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Alternative text to display when attachment is not displayed."),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L259"},"packages/core/src/data/types/entities.ts:259")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"author"},"author"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"author"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#author"},"author")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L94"},"packages/core/src/data/types/entities.ts:94")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"caption"},"caption"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"caption"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The attachment caption."),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L264"},"packages/core/src/data/types/entities.ts:264")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"comment_status"},"comment","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"comment","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not comments are open on the object."),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#comment_status"},"comment_status")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L106"},"packages/core/src/data/types/entities.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date"},"date"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date"},"date")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L42"},"packages/core/src/data/types/entities.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, as GMT."),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date_gmt"},"date_gmt")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L47"},"packages/core/src/data/types/entities.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"description"},"description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"description"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The attachment description."),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L269"},"packages/core/src/data/types/entities.ts:269")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"guid"},"guid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"guid"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The globally unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#guid"},"guid")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L52"},"packages/core/src/data/types/entities.ts:52")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#id"},"id")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L67"},"packages/core/src/data/types/entities.ts:67")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"link"},"link"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"link"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the object."),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#link"},"link")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L72"},"packages/core/src/data/types/entities.ts:72")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"media_details"},"media","_","details"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"media","_","details"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("p",null,"Details about the media file, specific to its type."),(0,i.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"file")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The file path relative to ",(0,i.kt)("inlineCode",{parentName:"td"},"wp-content/uploads"),".")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"height")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The height of the attachment.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"image_meta")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"unknown"),">"),(0,i.kt)("td",{parentName:"tr",align:"left"},"The metadata of the attachment.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"sizes")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),", { ",(0,i.kt)("inlineCode",{parentName:"td"},"file"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"height"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"mime_type"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"source_url"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"width"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"number")," }",">"),(0,i.kt)("td",{parentName:"tr",align:"left"},"The different sizes that WordPress created for this attachment.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"width")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The width of the attachment.")))),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L284"},"packages/core/src/data/types/entities.ts:284")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"media_type"},"media","_","type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"media","_","type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"image"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"file"')),(0,i.kt)("p",null,"Attachment type."),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L274"},"packages/core/src/data/types/entities.ts:274")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"meta"},"meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"meta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("p",null,"Meta fields."),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L249"},"packages/core/src/data/types/entities.ts:249")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"mime_type"},"mime","_","type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"mime","_","type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The attachment MIME type."),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L279"},"packages/core/src/data/types/entities.ts:279")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"missing_image_sizes"},"missing","_","image","_","sizes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"missing","_","image","_","sizes"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,i.kt)("p",null,"List of the missing image sizes of the attachment."),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L352"},"packages/core/src/data/types/entities.ts:352")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified"},"modified"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified"},"modified")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L57"},"packages/core/src/data/types/entities.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified_gmt"},"modified","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, as GMT."),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified_gmt"},"modified_gmt")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L62"},"packages/core/src/data/types/entities.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ping_status"},"ping","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ping","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not the object can be pinged."),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#ping_status"},"ping_status")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L111"},"packages/core/src/data/types/entities.ts:111")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"post"},"post"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"post"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The ID for the associated post of the attachment."),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L342"},"packages/core/src/data/types/entities.ts:342")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"slug"},"slug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"slug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"An alphanumeric identifier for the object unique to its type."),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#slug"},"slug")),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L77"},"packages/core/src/data/types/entities.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"source_url"},"source","_","url"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"source","_","url"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the original attachment file."),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L347"},"packages/core/src/data/types/entities.ts:347")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"private"')),(0,i.kt)("p",null,"A named status for the object."),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#status"},"status")),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L82"},"packages/core/src/data/types/entities.ts:82")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"template"},"template"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"template"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The theme file to use to display the object."),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L254"},"packages/core/src/data/types/entities.ts:254")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"terms"},"terms"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"terms"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#terms"},"terms")),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L96"},"packages/core/src/data/types/entities.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The title for the object."),(0,i.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#title"},"title")),(0,i.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L92"},"packages/core/src/data/types/entities.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"attachment"')),(0,i.kt)("p",null,"Type of Post for the object."),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#type"},"type")),(0,i.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L244"},"packages/core/src/data/types/entities.ts:244")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head"},"yoast_head")),(0,i.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L114"},"packages/core/src/data/types/entities.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head_json"},"yoast_head_json")),(0,i.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L113"},"packages/core/src/data/types/entities.ts:113")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/58adf8aa.97d03213.js b/assets/js/58adf8aa.e4330035.js similarity index 98% rename from assets/js/58adf8aa.97d03213.js rename to assets/js/58adf8aa.e4330035.js index 9b6e8bc0e..dc3d3f555 100644 --- a/assets/js/58adf8aa.97d03213.js +++ b/assets/js/58adf8aa.e4330035.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3133],{3905:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>m});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var s=n.createContext({}),l=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},u=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},d="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},b=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,s=e.parentName,u=c(e,["components","mdxType","originalType","parentName"]),d=l(r),b=o,m=d["".concat(s,".").concat(b)]||d[b]||p[b]||a;return r?n.createElement(m,i(i({ref:t},u),{},{components:r})):n.createElement(m,i({ref:t},u))}));function m(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,i=new Array(a);i[0]=b;var c={};for(var s in t)hasOwnProperty.call(t,s)&&(c[s]=t[s]);c.originalType=e,c[d]="string"==typeof e?e:o,i[1]=c;for(var l=2;l{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>d,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var n=r(7462),o=(r(7294),r(3905));const a={sidebar_label:"Rendering Custom Blocks",sidebar_position:1,slug:"/gutenberg/rendering-custom-blocks"},i="Rendering Custom Blocks",c={unversionedId:"Gutenberg/rendering-custom-blocks",id:"Gutenberg/rendering-custom-blocks",title:"Rendering Custom Blocks",description:"Custom Blocks can be handled in a very similar way. If you need to render your custom block as a react component you should make sure that the block exposes its data via the markup. You can do so by appending additional data to the data-wp-block-attrs attribute or serializing the data needed inside the block.",source:"@site/documentation/05-Gutenberg/rendering-custom-blocks.md",sourceDirName:"05-Gutenberg",slug:"/gutenberg/rendering-custom-blocks",permalink:"/docs/learn/gutenberg/rendering-custom-blocks",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/05-Gutenberg/rendering-custom-blocks.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:1,frontMatter:{sidebar_label:"Rendering Custom Blocks",sidebar_position:1,slug:"/gutenberg/rendering-custom-blocks"},sidebar:"tutorialSidebar",previous:{title:"Rendering Blocks",permalink:"/docs/learn/gutenberg/rendering-blocks"},next:{title:"Rendering Blocks in React Native",permalink:"/docs/learn/gutenberg/rendering-blocks-in-react-native"}},s={},l=[],u={toc:l};function d(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,n.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"rendering-custom-blocks"},"Rendering Custom Blocks"),(0,o.kt)("p",null,"Custom Blocks can be handled in a very similar way. If you need to render your custom block as a react component you should make sure that the block exposes its data via the markup. You can do so by appending additional data to the ",(0,o.kt)("inlineCode",{parentName:"p"},"data-wp-block-attrs")," attribute or serializing the data needed inside the block."))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3133],{3905:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>m});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var s=n.createContext({}),l=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},u=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},d="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},b=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,s=e.parentName,u=c(e,["components","mdxType","originalType","parentName"]),d=l(r),b=o,m=d["".concat(s,".").concat(b)]||d[b]||p[b]||a;return r?n.createElement(m,i(i({ref:t},u),{},{components:r})):n.createElement(m,i({ref:t},u))}));function m(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,i=new Array(a);i[0]=b;var c={};for(var s in t)hasOwnProperty.call(t,s)&&(c[s]=t[s]);c.originalType=e,c[d]="string"==typeof e?e:o,i[1]=c;for(var l=2;l{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>d,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var n=r(7462),o=(r(7294),r(3905));const a={sidebar_label:"Rendering Custom Blocks",sidebar_position:1,slug:"/gutenberg/rendering-custom-blocks"},i="Rendering Custom Blocks",c={unversionedId:"Gutenberg/rendering-custom-blocks",id:"Gutenberg/rendering-custom-blocks",title:"Rendering Custom Blocks",description:"Custom Blocks can be handled in a very similar way. If you need to render your custom block as a react component you should make sure that the block exposes its data via the markup. You can do so by appending additional data to the data-wp-block-attrs attribute or serializing the data needed inside the block.",source:"@site/documentation/05-Gutenberg/rendering-custom-blocks.md",sourceDirName:"05-Gutenberg",slug:"/gutenberg/rendering-custom-blocks",permalink:"/docs/learn/gutenberg/rendering-custom-blocks",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/05-Gutenberg/rendering-custom-blocks.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:1,frontMatter:{sidebar_label:"Rendering Custom Blocks",sidebar_position:1,slug:"/gutenberg/rendering-custom-blocks"},sidebar:"tutorialSidebar",previous:{title:"Rendering Blocks",permalink:"/docs/learn/gutenberg/rendering-blocks"},next:{title:"Rendering Blocks in React Native",permalink:"/docs/learn/gutenberg/rendering-blocks-in-react-native"}},s={},l=[],u={toc:l};function d(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,n.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"rendering-custom-blocks"},"Rendering Custom Blocks"),(0,o.kt)("p",null,"Custom Blocks can be handled in a very similar way. If you need to render your custom block as a react component you should make sure that the block exposes its data via the markup. You can do so by appending additional data to the ",(0,o.kt)("inlineCode",{parentName:"p"},"data-wp-block-attrs")," attribute or serializing the data needed inside the block."))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5a4180a9.1739ee3b.js b/assets/js/5a4180a9.a4526ed3.js similarity index 98% rename from assets/js/5a4180a9.1739ee3b.js rename to assets/js/5a4180a9.a4526ed3.js index cc359eddf..8c1dad474 100644 --- a/assets/js/5a4180a9.1739ee3b.js +++ b/assets/js/5a4180a9.a4526ed3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9589],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>g});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),u=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=u(e.components);return r.createElement(l.Provider,{value:t},e.children)},c="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),c=u(n),m=a,g=c["".concat(l,".").concat(m)]||c[m]||d[m]||i;return n?r.createElement(g,o(o({ref:t},p),{},{components:n})):r.createElement(g,o({ref:t},p))}));function g(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[c]="string"==typeof e?e:a,o[1]=s;for(var u=2;u{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>u});var r=n(7462),a=(n(7294),n(3905));const i={sidebar_label:"Quick Setup",slug:"/getting-started/quick-setup",sidebar_position:0},o="Quick Setup",s={unversionedId:"Getting Started/quick-setup",id:"Getting Started/quick-setup",title:"Quick Setup",description:"If you're new to Next.js, we recommend reviewing Next.js docs.",source:"@site/documentation/01-Getting Started/quick-setup.md",sourceDirName:"01-Getting Started",slug:"/getting-started/quick-setup",permalink:"/docs/learn/getting-started/quick-setup",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/01-Getting Started/quick-setup.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:0,frontMatter:{sidebar_label:"Quick Setup",slug:"/getting-started/quick-setup",sidebar_position:0},sidebar:"tutorialSidebar",previous:{title:"Introduction",permalink:"/docs/learn/"},next:{title:"Setting up the framework from scratch",permalink:"/docs/learn/getting-started/setting-up-manually"}},l={},u=[{value:"System Requirements",id:"system-requirements",level:2},{value:"Installation",id:"installation",level:2},{value:"Environment Variables",id:"environment-variables",level:3},{value:"Something Missing?",id:"something-missing",level:2}],p={toc:u};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"quick-setup"},"Quick Setup"),(0,a.kt)("p",null,"If you're new to Next.js, we recommend reviewing ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/getting-started"},"Next.js docs"),"."),(0,a.kt)("h2",{id:"system-requirements"},"System Requirements"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Node.js 16 or later"),(0,a.kt)("li",{parentName:"ul"},"NPM >= 7"),(0,a.kt)("li",{parentName:"ul"},"WordPress >= 5.9 (prior versions might work but haven't been tested).")),(0,a.kt)("h2",{id:"installation"},"Installation"),(0,a.kt)("p",null,"The easiest way to get started with HeadstartWP is by using ",(0,a.kt)("inlineCode",{parentName:"p"},"create-next-app")," with the official starter project."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"npx create-next-app --use-npm -e https://github.com/10up/headstartwp/tree/trunk/projects/wp-nextjs\n")),(0,a.kt)("p",null,"Then run ",(0,a.kt)("inlineCode",{parentName:"p"},"npm run dev")," and open http://localhost:3000 in your browser."),(0,a.kt)("h3",{id:"environment-variables"},"Environment Variables"),(0,a.kt)("p",null,"By default, the starter project will point to ",(0,a.kt)("inlineCode",{parentName:"p"},"js1.10up.com"),". Either change the\n",(0,a.kt)("inlineCode",{parentName:"p"},"NEXT_PUBLIC_HEADLESS_WP_URL")," variable or create a ",(0,a.kt)("inlineCode",{parentName:"p"},".env.local")," file to override the default env variables."),(0,a.kt)("p",null,"If you're developing locally and using HTTPS with WordPress and you don't have valid certs, you will need to add ",(0,a.kt)("inlineCode",{parentName:"p"},"NODE_TLS_REJECT_UNAUTHORIZED=0")," as an env variable"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"NEXT_PUBLIC_HEADLESS_WP_URL=https://wordpress.test\nNODE_TLS_REJECT_UNAUTHORIZED=0\n")),(0,a.kt)("h2",{id:"something-missing"},"Something Missing?"),(0,a.kt)("p",null,"If something is missing in the documentation or if you found some part confusing, please file an ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/issues"},"issue")," for the documentation repository with your suggestions for improvement."))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9589],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>g});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),u=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=u(e.components);return r.createElement(l.Provider,{value:t},e.children)},c="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),c=u(n),m=a,g=c["".concat(l,".").concat(m)]||c[m]||d[m]||i;return n?r.createElement(g,o(o({ref:t},p),{},{components:n})):r.createElement(g,o({ref:t},p))}));function g(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[c]="string"==typeof e?e:a,o[1]=s;for(var u=2;u{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>u});var r=n(7462),a=(n(7294),n(3905));const i={sidebar_label:"Quick Setup",slug:"/getting-started/quick-setup",sidebar_position:0},o="Quick Setup",s={unversionedId:"Getting Started/quick-setup",id:"Getting Started/quick-setup",title:"Quick Setup",description:"If you're new to Next.js, we recommend reviewing Next.js docs.",source:"@site/documentation/01-Getting Started/quick-setup.md",sourceDirName:"01-Getting Started",slug:"/getting-started/quick-setup",permalink:"/docs/learn/getting-started/quick-setup",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/01-Getting Started/quick-setup.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:0,frontMatter:{sidebar_label:"Quick Setup",slug:"/getting-started/quick-setup",sidebar_position:0},sidebar:"tutorialSidebar",previous:{title:"Introduction",permalink:"/docs/learn/"},next:{title:"Setting up the framework from scratch",permalink:"/docs/learn/getting-started/setting-up-manually"}},l={},u=[{value:"System Requirements",id:"system-requirements",level:2},{value:"Installation",id:"installation",level:2},{value:"Environment Variables",id:"environment-variables",level:3},{value:"Something Missing?",id:"something-missing",level:2}],p={toc:u};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"quick-setup"},"Quick Setup"),(0,a.kt)("p",null,"If you're new to Next.js, we recommend reviewing ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/getting-started"},"Next.js docs"),"."),(0,a.kt)("h2",{id:"system-requirements"},"System Requirements"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Node.js 16 or later"),(0,a.kt)("li",{parentName:"ul"},"NPM >= 7"),(0,a.kt)("li",{parentName:"ul"},"WordPress >= 5.9 (prior versions might work but haven't been tested).")),(0,a.kt)("h2",{id:"installation"},"Installation"),(0,a.kt)("p",null,"The easiest way to get started with HeadstartWP is by using ",(0,a.kt)("inlineCode",{parentName:"p"},"create-next-app")," with the official starter project."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"npx create-next-app --use-npm -e https://github.com/10up/headstartwp/tree/trunk/projects/wp-nextjs\n")),(0,a.kt)("p",null,"Then run ",(0,a.kt)("inlineCode",{parentName:"p"},"npm run dev")," and open http://localhost:3000 in your browser."),(0,a.kt)("h3",{id:"environment-variables"},"Environment Variables"),(0,a.kt)("p",null,"By default, the starter project will point to ",(0,a.kt)("inlineCode",{parentName:"p"},"js1.10up.com"),". Either change the\n",(0,a.kt)("inlineCode",{parentName:"p"},"NEXT_PUBLIC_HEADLESS_WP_URL")," variable or create a ",(0,a.kt)("inlineCode",{parentName:"p"},".env.local")," file to override the default env variables."),(0,a.kt)("p",null,"If you're developing locally and using HTTPS with WordPress and you don't have valid certs, you will need to add ",(0,a.kt)("inlineCode",{parentName:"p"},"NODE_TLS_REJECT_UNAUTHORIZED=0")," as an env variable"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"NEXT_PUBLIC_HEADLESS_WP_URL=https://wordpress.test\nNODE_TLS_REJECT_UNAUTHORIZED=0\n")),(0,a.kt)("h2",{id:"something-missing"},"Something Missing?"),(0,a.kt)("p",null,"If something is missing in the documentation or if you found some part confusing, please file an ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/issues"},"issue")," for the documentation repository with your suggestions for improvement."))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5bda4233.ba6d7430.js b/assets/js/5bda4233.2368d2b0.js similarity index 92% rename from assets/js/5bda4233.ba6d7430.js rename to assets/js/5bda4233.2368d2b0.js index b42c70c61..8ee34a056 100644 --- a/assets/js/5bda4233.ba6d7430.js +++ b/assets/js/5bda4233.2368d2b0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6815],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>f});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var s=n.createContext({}),l=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),c=l(a),k=i,f=c["".concat(s,".").concat(k)]||c[k]||h[k]||r;return a?n.createElement(f,p(p({ref:t},o),{},{components:a})):n.createElement(f,p({ref:t},o))}));function f(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=a.length,p=new Array(r);p[0]=k;var d={};for(var s in t)hasOwnProperty.call(t,s)&&(d[s]=t[s]);d.originalType=e,d[c]="string"==typeof e?e:i,p[1]=d;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var n=a(7462),i=(a(7294),a(3905));const r={id:"headstartwp_core.PostEntity",title:"Interface: PostEntity",sidebar_label:"@headstartwp/core.PostEntity",custom_edit_url:null},p=void 0,d={unversionedId:"interfaces/headstartwp_core.PostEntity",id:"interfaces/headstartwp_core.PostEntity",title:"Interface: PostEntity",description:"@headstartwp/core.PostEntity",source:"@site/docs/interfaces/headstartwp_core.PostEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PostEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostEntity",title:"Interface: PostEntity",sidebar_label:"@headstartwp/core.PostEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PolylangIntegration",permalink:"/docs/api/interfaces/headstartwp_core.PolylangIntegration"},next:{title:"@headstartwp/core.PostOrPostsParams",permalink:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"author",id:"author",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"categories",id:"categories",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"comment_status",id:"comment_status",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"content",id:"content",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"date",id:"date",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"excerpt",id:"excerpt",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"featured_media",id:"featured_media",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"format",id:"format",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"guid",id:"guid",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"link",id:"link",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"modified",id:"modified",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"modified_gmt",id:"modified_gmt",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"ping_status",id:"ping_status",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"slug",id:"slug",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"status",id:"status",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"sticky",id:"sticky",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"tags",id:"tags",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"template",id:"template",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"terms",id:"terms",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"type",id:"type",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-26",level:4}],o={toc:l};function c(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostEntity"),(0,i.kt)("p",null,"Interface for entities from the /wp/v2/posts endpoint."),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PostTypeEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"PostEntity"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"_embedded"},"_","embedded"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"author")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wp:term")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]")))),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#_embedded"},"_embedded")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L98"},"packages/core/src/data/types/entities.ts:98")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"author"},"author"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"author"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#author"},"author")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L94"},"packages/core/src/data/types/entities.ts:94")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"categories"},"categories"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"categories"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,i.kt)("p",null,"The terms assigned to the object in the category taxonomy."),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L164"},"packages/core/src/data/types/entities.ts:164")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"comment_status"},"comment","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"comment","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not comments are open on the object."),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#comment_status"},"comment_status")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L106"},"packages/core/src/data/types/entities.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"content"},"content"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"content"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The content for the object."),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L124"},"packages/core/src/data/types/entities.ts:124")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date"},"date"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date"},"date")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L42"},"packages/core/src/data/types/entities.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, as GMT."),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date_gmt"},"date_gmt")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L47"},"packages/core/src/data/types/entities.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"excerpt"},"excerpt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"excerpt"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The excerpt for the object."),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L129"},"packages/core/src/data/types/entities.ts:129")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"featured_media"},"featured","_","media"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"featured","_","media"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The ID of the featured media for the object."),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L174"},"packages/core/src/data/types/entities.ts:174")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"format"},"format"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"format"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"link"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"status"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"standard"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"aside"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"chat"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"gallery"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"image"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"quote"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"video"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"audio"')),(0,i.kt)("p",null,"The format for the object."),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L134"},"packages/core/src/data/types/entities.ts:134")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"guid"},"guid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"guid"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The globally unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#guid"},"guid")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L52"},"packages/core/src/data/types/entities.ts:52")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#id"},"id")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L67"},"packages/core/src/data/types/entities.ts:67")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"link"},"link"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"link"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the object."),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#link"},"link")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L72"},"packages/core/src/data/types/entities.ts:72")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"meta"},"meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"meta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("p",null,"Meta fields."),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L149"},"packages/core/src/data/types/entities.ts:149")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified"},"modified"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified"},"modified")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L57"},"packages/core/src/data/types/entities.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified_gmt"},"modified","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, as GMT."),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified_gmt"},"modified_gmt")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L62"},"packages/core/src/data/types/entities.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ping_status"},"ping","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ping","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not the object can be pinged."),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#ping_status"},"ping_status")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L111"},"packages/core/src/data/types/entities.ts:111")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"slug"},"slug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"slug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"An alphanumeric identifier for the object unique to its type."),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#slug"},"slug")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L77"},"packages/core/src/data/types/entities.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"private"')),(0,i.kt)("p",null,"A named status for the object."),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#status"},"status")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L82"},"packages/core/src/data/types/entities.ts:82")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sticky"},"sticky"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"sticky"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Whether or not the object should be treated as sticky."),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L154"},"packages/core/src/data/types/entities.ts:154")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"tags"},"tags"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"tags"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,i.kt)("p",null,"The terms assigned to the object in the post_tag taxonomy."),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L169"},"packages/core/src/data/types/entities.ts:169")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"template"},"template"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"template"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The theme file to use to display the object."),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L159"},"packages/core/src/data/types/entities.ts:159")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"terms"},"terms"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"terms"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#terms"},"terms")),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L96"},"packages/core/src/data/types/entities.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The title for the object."),(0,i.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#title"},"title")),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L92"},"packages/core/src/data/types/entities.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Type of Post for the object."),(0,i.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#type"},"type")),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L87"},"packages/core/src/data/types/entities.ts:87")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head"},"yoast_head")),(0,i.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L114"},"packages/core/src/data/types/entities.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head_json"},"yoast_head_json")),(0,i.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L113"},"packages/core/src/data/types/entities.ts:113")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6815],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>m});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var s=n.createContext({}),l=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),c=l(a),k=i,m=c["".concat(s,".").concat(k)]||c[k]||h[k]||r;return a?n.createElement(m,p(p({ref:t},o),{},{components:a})):n.createElement(m,p({ref:t},o))}));function m(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=a.length,p=new Array(r);p[0]=k;var d={};for(var s in t)hasOwnProperty.call(t,s)&&(d[s]=t[s]);d.originalType=e,d[c]="string"==typeof e?e:i,p[1]=d;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var n=a(7462),i=(a(7294),a(3905));const r={id:"headstartwp_core.PostEntity",title:"Interface: PostEntity",sidebar_label:"@headstartwp/core.PostEntity",custom_edit_url:null},p=void 0,d={unversionedId:"interfaces/headstartwp_core.PostEntity",id:"interfaces/headstartwp_core.PostEntity",title:"Interface: PostEntity",description:"@headstartwp/core.PostEntity",source:"@site/docs/interfaces/headstartwp_core.PostEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PostEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostEntity",title:"Interface: PostEntity",sidebar_label:"@headstartwp/core.PostEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PolylangIntegration",permalink:"/docs/api/interfaces/headstartwp_core.PolylangIntegration"},next:{title:"@headstartwp/core.PostOrPostsParams",permalink:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"author",id:"author",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"categories",id:"categories",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"comment_status",id:"comment_status",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"content",id:"content",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"date",id:"date",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"excerpt",id:"excerpt",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"featured_media",id:"featured_media",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"format",id:"format",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"guid",id:"guid",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"link",id:"link",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"modified",id:"modified",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"modified_gmt",id:"modified_gmt",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"ping_status",id:"ping_status",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"slug",id:"slug",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"status",id:"status",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"sticky",id:"sticky",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"tags",id:"tags",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"template",id:"template",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"terms",id:"terms",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"type",id:"type",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-26",level:4}],o={toc:l};function c(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostEntity"),(0,i.kt)("p",null,"Interface for entities from the /wp/v2/posts endpoint."),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PostTypeEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"PostEntity"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"_embedded"},"_","embedded"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"author")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wp:term")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]")))),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#_embedded"},"_embedded")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L98"},"packages/core/src/data/types/entities.ts:98")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"author"},"author"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"author"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#author"},"author")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L94"},"packages/core/src/data/types/entities.ts:94")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"categories"},"categories"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"categories"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,i.kt)("p",null,"The terms assigned to the object in the category taxonomy."),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L164"},"packages/core/src/data/types/entities.ts:164")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"comment_status"},"comment","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"comment","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not comments are open on the object."),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#comment_status"},"comment_status")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L106"},"packages/core/src/data/types/entities.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"content"},"content"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"content"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The content for the object."),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L124"},"packages/core/src/data/types/entities.ts:124")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date"},"date"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date"},"date")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L42"},"packages/core/src/data/types/entities.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, as GMT."),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date_gmt"},"date_gmt")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L47"},"packages/core/src/data/types/entities.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"excerpt"},"excerpt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"excerpt"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The excerpt for the object."),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L129"},"packages/core/src/data/types/entities.ts:129")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"featured_media"},"featured","_","media"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"featured","_","media"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The ID of the featured media for the object."),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L174"},"packages/core/src/data/types/entities.ts:174")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"format"},"format"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"format"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"link"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"status"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"standard"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"aside"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"chat"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"gallery"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"image"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"quote"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"video"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"audio"')),(0,i.kt)("p",null,"The format for the object."),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L134"},"packages/core/src/data/types/entities.ts:134")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"guid"},"guid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"guid"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The globally unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#guid"},"guid")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L52"},"packages/core/src/data/types/entities.ts:52")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#id"},"id")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L67"},"packages/core/src/data/types/entities.ts:67")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"link"},"link"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"link"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the object."),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#link"},"link")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L72"},"packages/core/src/data/types/entities.ts:72")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"meta"},"meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"meta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("p",null,"Meta fields."),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L149"},"packages/core/src/data/types/entities.ts:149")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified"},"modified"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified"},"modified")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L57"},"packages/core/src/data/types/entities.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified_gmt"},"modified","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, as GMT."),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified_gmt"},"modified_gmt")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L62"},"packages/core/src/data/types/entities.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ping_status"},"ping","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ping","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not the object can be pinged."),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#ping_status"},"ping_status")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L111"},"packages/core/src/data/types/entities.ts:111")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"slug"},"slug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"slug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"An alphanumeric identifier for the object unique to its type."),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#slug"},"slug")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L77"},"packages/core/src/data/types/entities.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"private"')),(0,i.kt)("p",null,"A named status for the object."),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#status"},"status")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L82"},"packages/core/src/data/types/entities.ts:82")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sticky"},"sticky"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"sticky"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Whether or not the object should be treated as sticky."),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L154"},"packages/core/src/data/types/entities.ts:154")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"tags"},"tags"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"tags"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,i.kt)("p",null,"The terms assigned to the object in the post_tag taxonomy."),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L169"},"packages/core/src/data/types/entities.ts:169")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"template"},"template"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"template"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The theme file to use to display the object."),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L159"},"packages/core/src/data/types/entities.ts:159")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"terms"},"terms"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"terms"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#terms"},"terms")),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L96"},"packages/core/src/data/types/entities.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The title for the object."),(0,i.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#title"},"title")),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L92"},"packages/core/src/data/types/entities.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Type of Post for the object."),(0,i.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#type"},"type")),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L87"},"packages/core/src/data/types/entities.ts:87")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head"},"yoast_head")),(0,i.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L114"},"packages/core/src/data/types/entities.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head_json"},"yoast_head_json")),(0,i.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L113"},"packages/core/src/data/types/entities.ts:113")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5e4e234e.84845489.js b/assets/js/5e4e234e.18d30c00.js similarity index 95% rename from assets/js/5e4e234e.84845489.js rename to assets/js/5e4e234e.18d30c00.js index 253e15422..c724ab34e 100644 --- a/assets/js/5e4e234e.84845489.js +++ b/assets/js/5e4e234e.18d30c00.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8596],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var s=n.createContext({}),p=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},l=function(e){var t=p(e.components);return n.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,s=e.parentName,l=c(e,["components","mdxType","originalType","parentName"]),d=p(r),h=a,f=d["".concat(s,".").concat(h)]||d[h]||u[h]||o;return r?n.createElement(f,i(i({ref:t},l),{},{components:r})):n.createElement(f,i({ref:t},l))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=h;var c={};for(var s in t)hasOwnProperty.call(t,s)&&(c[s]=t[s]);c.originalType=e,c[d]="string"==typeof e?e:a,i[1]=c;for(var p=2;p{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const o={id:"headstartwp_core.FetchOptions",title:"Interface: FetchOptions",sidebar_label:"@headstartwp/core.FetchOptions",custom_edit_url:null},i=void 0,c={unversionedId:"interfaces/headstartwp_core.FetchOptions",id:"interfaces/headstartwp_core.FetchOptions",title:"Interface: FetchOptions",description:"@headstartwp/core.FetchOptions",source:"@site/docs/interfaces/headstartwp_core.FetchOptions.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.FetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.FetchOptions",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.FetchOptions",title:"Interface: FetchOptions",sidebar_label:"@headstartwp/core.FetchOptions",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Entity",permalink:"/docs/api/interfaces/headstartwp_core.Entity"},next:{title:"@headstartwp/core.FetchResponse",permalink:"/docs/api/interfaces/headstartwp_core.FetchResponse"}},s={},p=[{value:"Properties",id:"properties",level:2},{value:"bearerToken",id:"bearertoken",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"burstCache",id:"burstcache",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"throwIfNotFound",id:"throwifnotfound",level:3},{value:"Defined in",id:"defined-in-2",level:4}],l={toc:p};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".FetchOptions"),(0,a.kt)("p",null,"The options supported by the default fetcher method"),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"bearertoken"},"bearerToken"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"bearerToken"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The authentication token to use for the request."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L66"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:66")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"burstcache"},"burstCache"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"burstCache"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"Whether to burst cache by appending a timestamp to the query"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L71"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:71")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"throwifnotfound"},"throwIfNotFound"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"throwIfNotFound"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"Whether to thrown an exception if data is not found."),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L61"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:61")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8596],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var s=n.createContext({}),p=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},l=function(e){var t=p(e.components);return n.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,s=e.parentName,l=c(e,["components","mdxType","originalType","parentName"]),d=p(r),h=a,f=d["".concat(s,".").concat(h)]||d[h]||u[h]||o;return r?n.createElement(f,i(i({ref:t},l),{},{components:r})):n.createElement(f,i({ref:t},l))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=h;var c={};for(var s in t)hasOwnProperty.call(t,s)&&(c[s]=t[s]);c.originalType=e,c[d]="string"==typeof e?e:a,i[1]=c;for(var p=2;p{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const o={id:"headstartwp_core.FetchOptions",title:"Interface: FetchOptions",sidebar_label:"@headstartwp/core.FetchOptions",custom_edit_url:null},i=void 0,c={unversionedId:"interfaces/headstartwp_core.FetchOptions",id:"interfaces/headstartwp_core.FetchOptions",title:"Interface: FetchOptions",description:"@headstartwp/core.FetchOptions",source:"@site/docs/interfaces/headstartwp_core.FetchOptions.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.FetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.FetchOptions",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.FetchOptions",title:"Interface: FetchOptions",sidebar_label:"@headstartwp/core.FetchOptions",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Entity",permalink:"/docs/api/interfaces/headstartwp_core.Entity"},next:{title:"@headstartwp/core.FetchResponse",permalink:"/docs/api/interfaces/headstartwp_core.FetchResponse"}},s={},p=[{value:"Properties",id:"properties",level:2},{value:"bearerToken",id:"bearertoken",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"burstCache",id:"burstcache",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"throwIfNotFound",id:"throwifnotfound",level:3},{value:"Defined in",id:"defined-in-2",level:4}],l={toc:p};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".FetchOptions"),(0,a.kt)("p",null,"The options supported by the default fetcher method"),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"bearertoken"},"bearerToken"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"bearerToken"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The authentication token to use for the request."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L66"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:66")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"burstcache"},"burstCache"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"burstCache"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"Whether to burst cache by appending a timestamp to the query"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L71"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:71")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"throwifnotfound"},"throwIfNotFound"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"throwIfNotFound"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("p",null,"Whether to thrown an exception if data is not found."),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L61"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:61")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5ea6ed43.971c5225.js b/assets/js/5ea6ed43.66e253a6.js similarity index 98% rename from assets/js/5ea6ed43.971c5225.js rename to assets/js/5ea6ed43.66e253a6.js index 34f23c87f..2767fc935 100644 --- a/assets/js/5ea6ed43.971c5225.js +++ b/assets/js/5ea6ed43.66e253a6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5787],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),p=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},l=function(e){var t=p(e.components);return a.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},f=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,s=e.parentName,l=c(e,["components","mdxType","originalType","parentName"]),d=p(r),f=n,m=d["".concat(s,".").concat(f)]||d[f]||u[f]||o;return r?a.createElement(m,i(i({ref:t},l),{},{components:r})):a.createElement(m,i({ref:t},l))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,i=new Array(o);i[0]=f;var c={};for(var s in t)hasOwnProperty.call(t,s)&&(c[s]=t[s]);c.originalType=e,c[d]="string"==typeof e?e:n,i[1]=c;for(var p=2;p{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.YoastSEOIntegration",title:"Interface: YoastSEOIntegration",sidebar_label:"@headstartwp/core.YoastSEOIntegration",custom_edit_url:null},i=void 0,c={unversionedId:"interfaces/headstartwp_core.YoastSEOIntegration",id:"interfaces/headstartwp_core.YoastSEOIntegration",title:"Interface: YoastSEOIntegration",description:"@headstartwp/core.YoastSEOIntegration",source:"@site/docs/interfaces/headstartwp_core.YoastSEOIntegration.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.YoastSEOIntegration",permalink:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.YoastSEOIntegration",title:"Interface: YoastSEOIntegration",sidebar_label:"@headstartwp/core.YoastSEOIntegration",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.VerifyTokenParams",permalink:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"},next:{title:"@headstartwp/core.react.AudioBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"}},s={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"enable",id:"enable",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4}],l={toc:p};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".YoastSEOIntegration"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration"},(0,n.kt)("inlineCode",{parentName:"a"},"Integration"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"YoastSEOIntegration"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"enable"},"enable"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"enable"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration"},"Integration"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration#enable"},"enable")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/types.ts#L46"},"packages/core/src/types.ts:46")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5787],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),p=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},l=function(e){var t=p(e.components);return a.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},f=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,s=e.parentName,l=c(e,["components","mdxType","originalType","parentName"]),d=p(r),f=n,m=d["".concat(s,".").concat(f)]||d[f]||u[f]||o;return r?a.createElement(m,i(i({ref:t},l),{},{components:r})):a.createElement(m,i({ref:t},l))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,i=new Array(o);i[0]=f;var c={};for(var s in t)hasOwnProperty.call(t,s)&&(c[s]=t[s]);c.originalType=e,c[d]="string"==typeof e?e:n,i[1]=c;for(var p=2;p{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.YoastSEOIntegration",title:"Interface: YoastSEOIntegration",sidebar_label:"@headstartwp/core.YoastSEOIntegration",custom_edit_url:null},i=void 0,c={unversionedId:"interfaces/headstartwp_core.YoastSEOIntegration",id:"interfaces/headstartwp_core.YoastSEOIntegration",title:"Interface: YoastSEOIntegration",description:"@headstartwp/core.YoastSEOIntegration",source:"@site/docs/interfaces/headstartwp_core.YoastSEOIntegration.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.YoastSEOIntegration",permalink:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.YoastSEOIntegration",title:"Interface: YoastSEOIntegration",sidebar_label:"@headstartwp/core.YoastSEOIntegration",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.VerifyTokenParams",permalink:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"},next:{title:"@headstartwp/core.react.AudioBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"}},s={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"enable",id:"enable",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4}],l={toc:p};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".YoastSEOIntegration"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration"},(0,n.kt)("inlineCode",{parentName:"a"},"Integration"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"YoastSEOIntegration"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"enable"},"enable"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"enable"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration"},"Integration"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration#enable"},"enable")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/types.ts#L46"},"packages/core/src/types.ts:46")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5fc1d772.ba14be4e.js b/assets/js/5fc1d772.6e1a97be.js similarity index 98% rename from assets/js/5fc1d772.ba14be4e.js rename to assets/js/5fc1d772.6e1a97be.js index e30c639d3..99d27093c 100644 --- a/assets/js/5fc1d772.ba14be4e.js +++ b/assets/js/5fc1d772.6e1a97be.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5205],{3905:(t,e,a)=>{a.d(e,{Zo:()=>m,kt:()=>c});var n=a(7294);function r(t,e,a){return e in t?Object.defineProperty(t,e,{value:a,enumerable:!0,configurable:!0,writable:!0}):t[e]=a,t}function i(t,e){var a=Object.keys(t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(t);e&&(n=n.filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable}))),a.push.apply(a,n)}return a}function l(t){for(var e=1;e=0||(r[a]=t[a]);return r}(t,e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(t);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(t,a)&&(r[a]=t[a])}return r}var d=n.createContext({}),o=function(t){var e=n.useContext(d),a=e;return t&&(a="function"==typeof t?t(e):l(l({},e),t)),a},m=function(t){var e=o(t.components);return n.createElement(d.Provider,{value:e},t.children)},k="mdxType",s={inlineCode:"code",wrapper:function(t){var e=t.children;return n.createElement(n.Fragment,{},e)}},N=n.forwardRef((function(t,e){var a=t.components,r=t.mdxType,i=t.originalType,d=t.parentName,m=p(t,["components","mdxType","originalType","parentName"]),k=o(a),N=r,c=k["".concat(d,".").concat(N)]||k[N]||s[N]||i;return a?n.createElement(c,l(l({ref:e},m),{},{components:a})):n.createElement(c,l({ref:e},m))}));function c(t,e){var a=arguments,r=e&&e.mdxType;if("string"==typeof t||r){var i=a.length,l=new Array(i);l[0]=N;var p={};for(var d in e)hasOwnProperty.call(e,d)&&(p[d]=e[d]);p.originalType=t,p[k]="string"==typeof t?t:r,l[1]=p;for(var o=2;o{a.r(e),a.d(e,{assets:()=>d,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.react.StylesProperties",title:"Interface: StylesProperties",sidebar_label:"@headstartwp/core.react.StylesProperties",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.StylesProperties",id:"interfaces/headstartwp_core.react.StylesProperties",title:"Interface: StylesProperties",description:"@headstartwp/core.react.StylesProperties",source:"@site/docs/interfaces/headstartwp_core.react.StylesProperties.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.StylesProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesProperties",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.StylesProperties",title:"Interface: StylesProperties",sidebar_label:"@headstartwp/core.react.StylesProperties",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.StylesElementsPropertiesComplete",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete"},next:{title:"@headstartwp/core.react.TableBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"}},d={},o=[{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"border",id:"border",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"color",id:"color",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"spacing",id:"spacing",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"typography",id:"typography",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Defined in",id:"defined-in-3",level:4}],m={toc:o};function k(t){let{components:e,...a}=t;return(0,r.kt)("wrapper",(0,n.Z)({},m,a,{components:e,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".StylesProperties"),(0,r.kt)("h2",{id:"indexable"},"Indexable"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"border"},"border"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"border"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Border styles."),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"color?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"border-color")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"radius?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"border-radius")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"border-style")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"width?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"border-width")," CSS property.")))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L555"},"packages/core/src/react/provider/types.ts:555")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"color"},"color"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"color"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Color styles."),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"background?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"background-color")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"gradient?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"background")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"color")," CSS property.")))),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L576"},"packages/core/src/react/provider/types.ts:576")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"spacing"},"spacing"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"spacing"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Spacing styles."),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockGap?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--style--block-gap")," CSS custom property when settings.spacing.blockGap is true.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"bottom?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"left?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"right?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"top?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Margin styles.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.bottom?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"margin-bottom")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.left?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"margin-left")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.right?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"margin-right")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.top?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"margin-top")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"bottom?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"left?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"right?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"top?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Padding styles.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.bottom?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"padding-bottom")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.left?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"padding-left")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.right?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"padding-right")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.top?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"padding-top")," CSS property.")))),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L593"},"packages/core/src/react/provider/types.ts:593")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"typography"},"typography"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"typography"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Typography styles."),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontFamily?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"font-family")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontSize?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"font-size")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontStyle?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"font-style")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontWeight?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"font-weight")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"letterSpacing?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"letter-spacing")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"lineHeight?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"line-height")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"textDecoration?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"text-decoration")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"textTransform?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"text-transform")," CSS property.")))),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L644"},"packages/core/src/react/provider/types.ts:644")))}k.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5205],{3905:(t,e,a)=>{a.d(e,{Zo:()=>m,kt:()=>c});var n=a(7294);function r(t,e,a){return e in t?Object.defineProperty(t,e,{value:a,enumerable:!0,configurable:!0,writable:!0}):t[e]=a,t}function i(t,e){var a=Object.keys(t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(t);e&&(n=n.filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable}))),a.push.apply(a,n)}return a}function l(t){for(var e=1;e=0||(r[a]=t[a]);return r}(t,e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(t);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(t,a)&&(r[a]=t[a])}return r}var d=n.createContext({}),o=function(t){var e=n.useContext(d),a=e;return t&&(a="function"==typeof t?t(e):l(l({},e),t)),a},m=function(t){var e=o(t.components);return n.createElement(d.Provider,{value:e},t.children)},k="mdxType",s={inlineCode:"code",wrapper:function(t){var e=t.children;return n.createElement(n.Fragment,{},e)}},N=n.forwardRef((function(t,e){var a=t.components,r=t.mdxType,i=t.originalType,d=t.parentName,m=p(t,["components","mdxType","originalType","parentName"]),k=o(a),N=r,c=k["".concat(d,".").concat(N)]||k[N]||s[N]||i;return a?n.createElement(c,l(l({ref:e},m),{},{components:a})):n.createElement(c,l({ref:e},m))}));function c(t,e){var a=arguments,r=e&&e.mdxType;if("string"==typeof t||r){var i=a.length,l=new Array(i);l[0]=N;var p={};for(var d in e)hasOwnProperty.call(e,d)&&(p[d]=e[d]);p.originalType=t,p[k]="string"==typeof t?t:r,l[1]=p;for(var o=2;o{a.r(e),a.d(e,{assets:()=>d,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.react.StylesProperties",title:"Interface: StylesProperties",sidebar_label:"@headstartwp/core.react.StylesProperties",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.StylesProperties",id:"interfaces/headstartwp_core.react.StylesProperties",title:"Interface: StylesProperties",description:"@headstartwp/core.react.StylesProperties",source:"@site/docs/interfaces/headstartwp_core.react.StylesProperties.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.StylesProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesProperties",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.StylesProperties",title:"Interface: StylesProperties",sidebar_label:"@headstartwp/core.react.StylesProperties",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.StylesElementsPropertiesComplete",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete"},next:{title:"@headstartwp/core.react.TableBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"}},d={},o=[{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"border",id:"border",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"color",id:"color",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"spacing",id:"spacing",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"typography",id:"typography",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Defined in",id:"defined-in-3",level:4}],m={toc:o};function k(t){let{components:e,...a}=t;return(0,r.kt)("wrapper",(0,n.Z)({},m,a,{components:e,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".StylesProperties"),(0,r.kt)("h2",{id:"indexable"},"Indexable"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"border"},"border"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"border"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Border styles."),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"color?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"border-color")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"radius?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"border-radius")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"border-style")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"width?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"border-width")," CSS property.")))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L555"},"packages/core/src/react/provider/types.ts:555")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"color"},"color"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"color"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Color styles."),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"background?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"background-color")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"gradient?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"background")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"color")," CSS property.")))),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L576"},"packages/core/src/react/provider/types.ts:576")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"spacing"},"spacing"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"spacing"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Spacing styles."),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockGap?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--style--block-gap")," CSS custom property when settings.spacing.blockGap is true.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"bottom?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"left?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"right?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"top?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Margin styles.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.bottom?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"margin-bottom")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.left?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"margin-left")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.right?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"margin-right")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.top?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"margin-top")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"bottom?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"left?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"right?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"top?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Padding styles.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.bottom?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"padding-bottom")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.left?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"padding-left")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.right?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"padding-right")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.top?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"padding-top")," CSS property.")))),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L593"},"packages/core/src/react/provider/types.ts:593")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"typography"},"typography"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"typography"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Typography styles."),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontFamily?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"font-family")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontSize?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"font-size")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontStyle?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"font-style")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontWeight?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"font-weight")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"letterSpacing?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"letter-spacing")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"lineHeight?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"line-height")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"textDecoration?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"text-decoration")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"textTransform?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"text-transform")," CSS property.")))),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L644"},"packages/core/src/react/provider/types.ts:644")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/637a3551.faa2cbd3.js b/assets/js/637a3551.4a61de60.js similarity index 95% rename from assets/js/637a3551.faa2cbd3.js rename to assets/js/637a3551.4a61de60.js index f7bcca381..aed7f3802 100644 --- a/assets/js/637a3551.faa2cbd3.js +++ b/assets/js/637a3551.4a61de60.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3200],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function p(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var o=a.createContext({}),c=function(e){var t=a.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},s=function(e){var t=c(e.components);return a.createElement(o.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),d=c(r),m=n,h=d["".concat(o,".").concat(m)]||d[m]||k[m]||i;return r?a.createElement(h,p(p({ref:t},s),{},{components:r})):a.createElement(h,p({ref:t},s))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,p=new Array(i);p[0]=m;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l[d]="string"==typeof e?e:n,p[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.VerseBlockProps",title:"Interface: VerseBlockProps",sidebar_label:"@headstartwp/core.react.VerseBlockProps",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.react.VerseBlockProps",id:"interfaces/headstartwp_core.react.VerseBlockProps",title:"Interface: VerseBlockProps",description:"@headstartwp/core.react.VerseBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.VerseBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.VerseBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.VerseBlockProps",title:"Interface: VerseBlockProps",sidebar_label:"@headstartwp/core.react.VerseBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.Typography",permalink:"/docs/api/interfaces/headstartwp_core.react.Typography"},next:{title:"@headstartwp/core.react.WpThemeJSON",permalink:"/docs/api/interfaces/headstartwp_core.react.WpThemeJSON"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".VerseBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"VerseBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3200],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function p(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var o=a.createContext({}),c=function(e){var t=a.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},s=function(e){var t=c(e.components);return a.createElement(o.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),d=c(r),m=n,h=d["".concat(o,".").concat(m)]||d[m]||k[m]||i;return r?a.createElement(h,p(p({ref:t},s),{},{components:r})):a.createElement(h,p({ref:t},s))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,p=new Array(i);p[0]=m;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l[d]="string"==typeof e?e:n,p[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.VerseBlockProps",title:"Interface: VerseBlockProps",sidebar_label:"@headstartwp/core.react.VerseBlockProps",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.react.VerseBlockProps",id:"interfaces/headstartwp_core.react.VerseBlockProps",title:"Interface: VerseBlockProps",description:"@headstartwp/core.react.VerseBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.VerseBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.VerseBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.VerseBlockProps",title:"Interface: VerseBlockProps",sidebar_label:"@headstartwp/core.react.VerseBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.Typography",permalink:"/docs/api/interfaces/headstartwp_core.react.Typography"},next:{title:"@headstartwp/core.react.WpThemeJSON",permalink:"/docs/api/interfaces/headstartwp_core.react.WpThemeJSON"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".VerseBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"VerseBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/66ab7d90.3d8098f7.js b/assets/js/66ab7d90.70f5cdd8.js similarity index 96% rename from assets/js/66ab7d90.3d8098f7.js rename to assets/js/66ab7d90.70f5cdd8.js index fb1039bc0..ab98fc463 100644 --- a/assets/js/66ab7d90.3d8098f7.js +++ b/assets/js/66ab7d90.70f5cdd8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[520],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>u});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function s(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),l=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=l(e.components);return r.createElement(p.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,s=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),c=l(a),m=n,u=c["".concat(p,".").concat(m)]||c[m]||h[m]||s;return a?r.createElement(u,i(i({ref:t},d),{},{components:a})):r.createElement(u,i({ref:t},d))}));function u(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var s=a.length,i=new Array(s);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[c]="string"==typeof e?e:n,i[1]=o;for(var l=2;l{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>c,frontMatter:()=>s,metadata:()=>o,toc:()=>l});var r=a(7462),n=(a(7294),a(3905));const s={id:"headstartwp_core.PostOrPostsParams",title:"Interface: PostOrPostsParams",sidebar_label:"@headstartwp/core.PostOrPostsParams",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.PostOrPostsParams",id:"interfaces/headstartwp_core.PostOrPostsParams",title:"Interface: PostOrPostsParams",description:"@headstartwp/core.PostOrPostsParams",source:"@site/docs/interfaces/headstartwp_core.PostOrPostsParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PostOrPostsParams",permalink:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostOrPostsParams",title:"Interface: PostOrPostsParams",sidebar_label:"@headstartwp/core.PostOrPostsParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostEntity"},next:{title:"@headstartwp/core.PostParams",permalink:"/docs/api/interfaces/headstartwp_core.PostParams"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"archive",id:"archive",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"lang",id:"lang",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"priority",id:"priority",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"routeMatchStrategy",id:"routematchstrategy",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"single",id:"single",level:3},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:l};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostOrPostsParams"),(0,n.kt)("p",null,"The params supported by ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy"},"PostOrPostsFetchStrategy")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PostOrPostsParams"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"_embed"},"_","embed"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"The _embed param returned associated entities in the response"),(0,n.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_embed"},"_embed")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"_fields"},"_","fields"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_fields"},"_fields")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"archive"},"archive"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"archive"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")),">"),(0,n.kt)("p",null,"The ",(0,n.kt)("inlineCode",{parentName:"p"},"archive")," params corresponds to ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},"PostsArchiveParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L25"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:25")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"lang"},"lang"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"lang"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The polylang ?lang parameter."),(0,n.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#lang"},"lang")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"priority"},"priority"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"priority"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"archive"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"single"')),(0,n.kt)("p",null,"The priority indicates which strategy should execute first."),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L30"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:30")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"routematchstrategy"},"routeMatchStrategy"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"routeMatchStrategy"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"none"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"archive"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"single"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"both"')),(0,n.kt)("p",null,"How to handle route matching strategy, the possible values are:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"single")," will only trigger the single strategy if there's a url match for the single strategy"),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"archive")," will only trigger the archive strategy if there's a url match for the archive strategy"),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"both")," requires a route match for both single and archive")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L39"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:39")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"single"},"single"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"single"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams")),">"),(0,n.kt)("p",null,"The ",(0,n.kt)("inlineCode",{parentName:"p"},"single")," params corresponds to ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostParams"},"PostParams")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L20"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:20")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[520],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>u});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function s(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),l=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=l(e.components);return r.createElement(p.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,s=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),c=l(a),m=n,u=c["".concat(p,".").concat(m)]||c[m]||h[m]||s;return a?r.createElement(u,i(i({ref:t},d),{},{components:a})):r.createElement(u,i({ref:t},d))}));function u(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var s=a.length,i=new Array(s);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[c]="string"==typeof e?e:n,i[1]=o;for(var l=2;l{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>c,frontMatter:()=>s,metadata:()=>o,toc:()=>l});var r=a(7462),n=(a(7294),a(3905));const s={id:"headstartwp_core.PostOrPostsParams",title:"Interface: PostOrPostsParams",sidebar_label:"@headstartwp/core.PostOrPostsParams",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.PostOrPostsParams",id:"interfaces/headstartwp_core.PostOrPostsParams",title:"Interface: PostOrPostsParams",description:"@headstartwp/core.PostOrPostsParams",source:"@site/docs/interfaces/headstartwp_core.PostOrPostsParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PostOrPostsParams",permalink:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostOrPostsParams",title:"Interface: PostOrPostsParams",sidebar_label:"@headstartwp/core.PostOrPostsParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostEntity"},next:{title:"@headstartwp/core.PostParams",permalink:"/docs/api/interfaces/headstartwp_core.PostParams"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"archive",id:"archive",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"lang",id:"lang",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"priority",id:"priority",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"routeMatchStrategy",id:"routematchstrategy",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"single",id:"single",level:3},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:l};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostOrPostsParams"),(0,n.kt)("p",null,"The params supported by ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy"},"PostOrPostsFetchStrategy")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PostOrPostsParams"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"_embed"},"_","embed"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"The _embed param returned associated entities in the response"),(0,n.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_embed"},"_embed")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"_fields"},"_","fields"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_fields"},"_fields")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"archive"},"archive"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"archive"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")),">"),(0,n.kt)("p",null,"The ",(0,n.kt)("inlineCode",{parentName:"p"},"archive")," params corresponds to ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},"PostsArchiveParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L25"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:25")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"lang"},"lang"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"lang"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The polylang ?lang parameter."),(0,n.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#lang"},"lang")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"priority"},"priority"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"priority"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"archive"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"single"')),(0,n.kt)("p",null,"The priority indicates which strategy should execute first."),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L30"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:30")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"routematchstrategy"},"routeMatchStrategy"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"routeMatchStrategy"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"none"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"archive"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"single"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"both"')),(0,n.kt)("p",null,"How to handle route matching strategy, the possible values are:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"single")," will only trigger the single strategy if there's a url match for the single strategy"),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"archive")," will only trigger the archive strategy if there's a url match for the archive strategy"),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"both")," requires a route match for both single and archive")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L39"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:39")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"single"},"single"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"single"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams")),">"),(0,n.kt)("p",null,"The ",(0,n.kt)("inlineCode",{parentName:"p"},"single")," params corresponds to ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostParams"},"PostParams")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L20"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:20")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/66decef0.254e0d92.js b/assets/js/66decef0.6bf62550.js similarity index 97% rename from assets/js/66decef0.254e0d92.js rename to assets/js/66decef0.6bf62550.js index e886ad4c9..1d8d163bd 100644 --- a/assets/js/66decef0.254e0d92.js +++ b/assets/js/66decef0.6bf62550.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1932],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.IQuoteBlock",title:"Interface: IQuoteBlock",sidebar_label:"@headstartwp/core.react.IQuoteBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IQuoteBlock",id:"interfaces/headstartwp_core.react.IQuoteBlock",title:"Interface: IQuoteBlock",description:"@headstartwp/core.react.IQuoteBlock",source:"@site/docs/interfaces/headstartwp_core.react.IQuoteBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IQuoteBlock",title:"Interface: IQuoteBlock",sidebar_label:"@headstartwp/core.react.IQuoteBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IPullQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock"},next:{title:"@headstartwp/core.react.ISeparatorBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IQuoteBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"QuoteBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IQuoteBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"QuoteBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"QuoteBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1932],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.IQuoteBlock",title:"Interface: IQuoteBlock",sidebar_label:"@headstartwp/core.react.IQuoteBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IQuoteBlock",id:"interfaces/headstartwp_core.react.IQuoteBlock",title:"Interface: IQuoteBlock",description:"@headstartwp/core.react.IQuoteBlock",source:"@site/docs/interfaces/headstartwp_core.react.IQuoteBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IQuoteBlock",title:"Interface: IQuoteBlock",sidebar_label:"@headstartwp/core.react.IQuoteBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IPullQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock"},next:{title:"@headstartwp/core.react.ISeparatorBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IQuoteBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"QuoteBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IQuoteBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"QuoteBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"QuoteBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/670e912d.9a0ba582.js b/assets/js/670e912d.b60c023b.js similarity index 98% rename from assets/js/670e912d.9a0ba582.js rename to assets/js/670e912d.b60c023b.js index b57edf631..92356afa6 100644 --- a/assets/js/670e912d.9a0ba582.js +++ b/assets/js/670e912d.b60c023b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1497],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function c(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var u=n.createContext({}),l=function(e){var t=n.useContext(u),r=t;return e&&(r="function"==typeof e?e(t):c(c({},t),e)),r},d=function(e){var t=l(e.components);return n.createElement(u.Provider,{value:t},e.children)},s="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,u=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=l(r),f=a,m=s["".concat(u,".").concat(f)]||s[f]||p[f]||o;return r?n.createElement(m,c(c({ref:t},d),{},{components:r})):n.createElement(m,c({ref:t},d))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,c=new Array(o);c[0]=f;var i={};for(var u in t)hasOwnProperty.call(t,u)&&(i[u]=t[u]);i.originalType=e,i[s]="string"==typeof e?e:a,c[1]=i;for(var l=2;l{r.r(t),r.d(t,{assets:()=>u,contentTitle:()=>c,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var n=r(7462),a=(r(7294),r(3905));const o={},c="Implementing a Youtube Facade",i={unversionedId:"Guides/youtube-facade",id:"Guides/youtube-facade",title:"Implementing a Youtube Facade",description:"HeadstartWP provides an easy way to implement Youtube Facade, in fact, we can do so with one line of code. All that\u2019s needed is to add the YoutubeLiteBlock component",source:"@site/documentation/08-Guides/youtube-facade.md",sourceDirName:"08-Guides",slug:"/Guides/youtube-facade",permalink:"/docs/learn/Guides/youtube-facade",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/08-Guides/youtube-facade.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"TypeScript",permalink:"/docs/learn/Guides/typescript"}},u={},l=[],d={toc:l};function s(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"implementing-a-youtube-facade"},"Implementing a Youtube Facade"),(0,a.kt)("p",null,"HeadstartWP provides an easy way to implement Youtube Facade, in fact, we can do so with one line of code. All that\u2019s needed is to add the YoutubeLiteBlock component"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"import { BlocksRenderer, YoutubeLiteBlock } from '@headstartwp/core/react';\n\n\n {/*... */}\n \n\n")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1497],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function c(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var u=n.createContext({}),l=function(e){var t=n.useContext(u),r=t;return e&&(r="function"==typeof e?e(t):c(c({},t),e)),r},d=function(e){var t=l(e.components);return n.createElement(u.Provider,{value:t},e.children)},s="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,u=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=l(r),f=a,m=s["".concat(u,".").concat(f)]||s[f]||p[f]||o;return r?n.createElement(m,c(c({ref:t},d),{},{components:r})):n.createElement(m,c({ref:t},d))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,c=new Array(o);c[0]=f;var i={};for(var u in t)hasOwnProperty.call(t,u)&&(i[u]=t[u]);i.originalType=e,i[s]="string"==typeof e?e:a,c[1]=i;for(var l=2;l{r.r(t),r.d(t,{assets:()=>u,contentTitle:()=>c,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var n=r(7462),a=(r(7294),r(3905));const o={},c="Implementing a Youtube Facade",i={unversionedId:"Guides/youtube-facade",id:"Guides/youtube-facade",title:"Implementing a Youtube Facade",description:"HeadstartWP provides an easy way to implement Youtube Facade, in fact, we can do so with one line of code. All that\u2019s needed is to add the YoutubeLiteBlock component",source:"@site/documentation/08-Guides/youtube-facade.md",sourceDirName:"08-Guides",slug:"/Guides/youtube-facade",permalink:"/docs/learn/Guides/youtube-facade",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/08-Guides/youtube-facade.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"TypeScript",permalink:"/docs/learn/Guides/typescript"}},u={},l=[],d={toc:l};function s(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"implementing-a-youtube-facade"},"Implementing a Youtube Facade"),(0,a.kt)("p",null,"HeadstartWP provides an easy way to implement Youtube Facade, in fact, we can do so with one line of code. All that\u2019s needed is to add the YoutubeLiteBlock component"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"import { BlocksRenderer, YoutubeLiteBlock } from '@headstartwp/core/react';\n\n\n {/*... */}\n \n\n")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6e304a43.a8d61b25.js b/assets/js/6e304a43.a5f32711.js similarity index 97% rename from assets/js/6e304a43.a8d61b25.js rename to assets/js/6e304a43.a5f32711.js index 9c0e2c216..d0faba4a5 100644 --- a/assets/js/6e304a43.a8d61b25.js +++ b/assets/js/6e304a43.a5f32711.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2069],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.ISpacerBlock",title:"Interface: ISpacerBlock",sidebar_label:"@headstartwp/core.react.ISpacerBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ISpacerBlock",id:"interfaces/headstartwp_core.react.ISpacerBlock",title:"Interface: ISpacerBlock",description:"@headstartwp/core.react.ISpacerBlock",source:"@site/docs/interfaces/headstartwp_core.react.ISpacerBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ISpacerBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ISpacerBlock",title:"Interface: ISpacerBlock",sidebar_label:"@headstartwp/core.react.ISpacerBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ISeparatorBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock"},next:{title:"@headstartwp/core.react.ITableBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ITableBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ISpacerBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SpacerBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ISpacerBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SpacerBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SpacerBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2069],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.ISpacerBlock",title:"Interface: ISpacerBlock",sidebar_label:"@headstartwp/core.react.ISpacerBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ISpacerBlock",id:"interfaces/headstartwp_core.react.ISpacerBlock",title:"Interface: ISpacerBlock",description:"@headstartwp/core.react.ISpacerBlock",source:"@site/docs/interfaces/headstartwp_core.react.ISpacerBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ISpacerBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ISpacerBlock",title:"Interface: ISpacerBlock",sidebar_label:"@headstartwp/core.react.ISpacerBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ISeparatorBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock"},next:{title:"@headstartwp/core.react.ITableBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ITableBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ISpacerBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SpacerBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ISpacerBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SpacerBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SpacerBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6e83ed71.0086750a.js b/assets/js/6e83ed71.8009d85b.js similarity index 96% rename from assets/js/6e83ed71.0086750a.js rename to assets/js/6e83ed71.8009d85b.js index 60e6fb143..3252387ec 100644 --- a/assets/js/6e83ed71.0086750a.js +++ b/assets/js/6e83ed71.8009d85b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1513],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var d=n.createContext({}),o=function(e){var t=n.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},s=function(e){var t=o(e.components);return n.createElement(d.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),c=o(a),k=r,h=c["".concat(d,".").concat(k)]||c[k]||m[k]||i;return a?n.createElement(h,p(p({ref:t},s),{},{components:a})):n.createElement(h,p({ref:t},s))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=k;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l[c]="string"==typeof e?e:r,p[1]=l;for(var o=2;o{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>o});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.AppEntity",title:"Interface: AppEntity",sidebar_label:"@headstartwp/core.AppEntity",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.AppEntity",id:"interfaces/headstartwp_core.AppEntity",title:"Interface: AppEntity",description:"@headstartwp/core.AppEntity",source:"@site/docs/interfaces/headstartwp_core.AppEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.AppEntity",permalink:"/docs/api/interfaces/headstartwp_core.AppEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AppEntity",title:"Interface: AppEntity",sidebar_label:"@headstartwp/core.AppEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.VerifyTokenFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy"},next:{title:"@headstartwp/core.AttachmentEntity",permalink:"/docs/api/interfaces/headstartwp_core.AttachmentEntity"}},d={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"home",id:"home",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"menus",id:"menus",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"settings",id:"settings",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"theme.json",id:"themejson",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-5",level:4}],s={toc:o};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AppEntity"),(0,r.kt)("p",null,"Empty interface from which all entities inherit."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"AppEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"home"},"home"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"home"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L681"},"packages/core/src/data/types/entities.ts:681")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menus"},"menus"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"menus"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"index-signature"},"Index signature"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuItemEntity")),"[]"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L678"},"packages/core/src/data/types/entities.ts:678")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settings"},"settings"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"settings"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"posts_per_page")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"privacy_policy_url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site_desc")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site_name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site_rss_url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site_wp_url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L685"},"packages/core/src/data/types/entities.ts:685")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"themejson"},"theme.json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"theme.json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L693"},"packages/core/src/data/types/entities.ts:693")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1513],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var d=n.createContext({}),o=function(e){var t=n.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},s=function(e){var t=o(e.components);return n.createElement(d.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),c=o(a),k=r,h=c["".concat(d,".").concat(k)]||c[k]||m[k]||i;return a?n.createElement(h,p(p({ref:t},s),{},{components:a})):n.createElement(h,p({ref:t},s))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=k;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l[c]="string"==typeof e?e:r,p[1]=l;for(var o=2;o{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>o});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.AppEntity",title:"Interface: AppEntity",sidebar_label:"@headstartwp/core.AppEntity",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.AppEntity",id:"interfaces/headstartwp_core.AppEntity",title:"Interface: AppEntity",description:"@headstartwp/core.AppEntity",source:"@site/docs/interfaces/headstartwp_core.AppEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.AppEntity",permalink:"/docs/api/interfaces/headstartwp_core.AppEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AppEntity",title:"Interface: AppEntity",sidebar_label:"@headstartwp/core.AppEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.VerifyTokenFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy"},next:{title:"@headstartwp/core.AttachmentEntity",permalink:"/docs/api/interfaces/headstartwp_core.AttachmentEntity"}},d={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"home",id:"home",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"menus",id:"menus",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"settings",id:"settings",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"theme.json",id:"themejson",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-5",level:4}],s={toc:o};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AppEntity"),(0,r.kt)("p",null,"Empty interface from which all entities inherit."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"AppEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"home"},"home"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"home"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L681"},"packages/core/src/data/types/entities.ts:681")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menus"},"menus"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"menus"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"index-signature"},"Index signature"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuItemEntity")),"[]"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L678"},"packages/core/src/data/types/entities.ts:678")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settings"},"settings"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"settings"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"posts_per_page")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"privacy_policy_url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site_desc")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site_name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site_rss_url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site_wp_url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L685"},"packages/core/src/data/types/entities.ts:685")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"themejson"},"theme.json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"theme.json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L693"},"packages/core/src/data/types/entities.ts:693")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6e8d7793.7c5d5d59.js b/assets/js/6e8d7793.8b8330b9.js similarity index 99% rename from assets/js/6e8d7793.7c5d5d59.js rename to assets/js/6e8d7793.8b8330b9.js index 6e09ce85d..94fad316b 100644 --- a/assets/js/6e8d7793.7c5d5d59.js +++ b/assets/js/6e8d7793.8b8330b9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7272],{3905:(e,t,n)=>{n.d(t,{Zo:()=>h,kt:()=>m});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=a.createContext({}),p=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},h=function(e){var t=p(e.components);return a.createElement(l.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,h=i(e,["components","mdxType","originalType","parentName"]),c=p(n),d=r,m=c["".concat(l,".").concat(d)]||c[d]||u[d]||o;return n?a.createElement(m,s(s({ref:t},h),{},{components:n})):a.createElement(m,s({ref:t},h))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,s=new Array(o);s[0]=d;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[c]="string"==typeof e?e:r,s[1]=i;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>c,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var a=n(7462),r=(n(7294),n(3905));const o={slug:"/data-fetching/use-post-or-posts",sidebar_position:4},s="The usePostOrPosts hook",i={unversionedId:"Data Fetching/usePostOrPosts",id:"Data Fetching/usePostOrPosts",title:"The usePostOrPosts hook",description:"This hook was introduced in @headstartwp/core@1.1.0 and @headstartwp/next@1.1.0",source:"@site/documentation/02 - Data Fetching/usePostOrPosts.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/use-post-or-posts",permalink:"/docs/learn/data-fetching/use-post-or-posts",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/usePostOrPosts.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:4,frontMatter:{slug:"/data-fetching/use-post-or-posts",sidebar_position:4},sidebar:"tutorialSidebar",previous:{title:"The useAuthorArchive Hook",permalink:"/docs/learn/data-fetching/useauthorarchive"},next:{title:"The useTerms hook",permalink:"/docs/learn/data-fetching/useterms"}},l={},p=[{value:"Basic Usage",id:"basic-usage",level:2},{value:"Return values",id:"return-values",level:3},{value:"single and archive params",id:"single-and-archive-params",level:3},{value:"priority",id:"priority",level:3},{value:"routeMatchStrategy",id:"routematchstrategy",level:3}],h={toc:p};function c(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},h,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"the-usepostorposts-hook"},"The usePostOrPosts hook"),(0,r.kt)("admonition",{type:"info"},(0,r.kt)("p",{parentName:"admonition"},"This hook was introduced in ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/core@1.1.0")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/next@1.1.0"))),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"The ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#usepostorposts"},"usePostOrPosts")," hook is the Next.js binding for the ",(0,r.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchpostorposts"},"useFetchPostOrPosts"),".")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostOrPosts")," fetch either a single post or a collection of posts based on the current path. It is useful when you want to prefix the archive and the single posts with the same prefix. E.g: /blog/post-name and /blog/news"),(0,r.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},"// src/pages/blog/[...path].js\n\nconst blogParams = {\n single: {\n postType: 'post',\n },\n archive: {\n postType: 'post',\n taxonomy: 'category',\n },\n priority: 'single',\n routeMatchStrategy: 'single',\n};\n\nconst Archive = () => {\n const { data } = usePosts(blogParams.archive);\n\n return (\n <>\n

Blog Page

\n
    \n {data.posts.map((post) => (\n
  • \n {post.title.rendered}\n
  • \n ))}\n
\n \n );\n};\n\nconst PageContent = ({ params }) => {\n const { data } = usePost(params);\n\n return (\n <>\n

\n \n

\n \n \n );\n};\n\n\nconst BlogPage = () => {\n const { isArchive } = usePostOrPosts(blogParams);\n\n if (isArchive) {\n return ;\n }\n\n return ;\n};\n\nexport async function getServerSideProps(context) {\n try {\n const settledPromises = await resolveBatch([\n {\n func: fetchHookData(usePostOrPosts.fetcher(), context, { params: blogParams }),\n },\n ]);\n\n return addHookData(settledPromises, {});\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("p",null,"The above route will match the following URLs:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"/blog/","[category]"),(0,r.kt)("li",{parentName:"ul"},"/blog/","[category]","/page/","[page]"),(0,r.kt)("li",{parentName:"ul"},"/blog/","[category]","/","[post-name]"," (this route will only work if the ",(0,r.kt)("inlineCode",{parentName:"li"},"post.link")," property matches this structure in WP)"),(0,r.kt)("li",{parentName:"ul"},"/blog/","[post-name]"," (this route will only work if the ",(0,r.kt)("inlineCode",{parentName:"li"},"post.link")," property matches this structure in WP)")),(0,r.kt)("h3",{id:"return-values"},"Return values"),(0,r.kt)("p",null,"This hook returns the following things:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"isArchive"),": true if the resulting data is for an archive"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"isSingle"),": true if the resulting data is for a single post"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"post"),": if isSingle is true, will hold the data for a single post"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"posts"),": if isArchive is true, will hold the data for an archive")),(0,r.kt)("p",null,"When using the ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostOrPosts")," hook you can also use ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," without needing to make additional fetch calls. The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostOrPosts")," hook will populate the cache for ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts"),". That is why in the example on the page, the actual data is pulled from ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts"),"."),(0,r.kt)("h3",{id:"single-and-archive-params"},"single and archive params"),(0,r.kt)("p",null,"The route above is going to try to fetch either a single post or a post archive based on the current URL. The parameters passed to ",(0,r.kt)("inlineCode",{parentName:"p"},"single")," are the ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," parameters and the ",(0,r.kt)("inlineCode",{parentName:"p"},"archive")," params are the ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," params."),(0,r.kt)("h3",{id:"priority"},"priority"),(0,r.kt)("p",null,"The possible values for ",(0,r.kt)("inlineCode",{parentName:"p"},"priority")," are ",(0,r.kt)("inlineCode",{parentName:"p"},"single")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"archive"),". This setting exists to prioritize one strategy over the other when there are URL collisions. In the example on this page, there could be a slug collision where a post exists with the slug of a category. In that case, the ",(0,r.kt)("inlineCode",{parentName:"p"},"priority")," setting will dictate which one is going to be used."),(0,r.kt)("h3",{id:"routematchstrategy"},"routeMatchStrategy"),(0,r.kt)("p",null,"This setting controls whether ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," should match the fetch strategy. The possible values are ",(0,r.kt)("inlineCode",{parentName:"p"},"none")," (default), ",(0,r.kt)("inlineCode",{parentName:"p"},"single"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"archive")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"both"),"."),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"single"),": Will only fetch a single post if ",(0,r.kt)("inlineCode",{parentName:"li"},"[...path].js")," matches the structure of a single."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"archive"),": Will only fetch an archive if ",(0,r.kt)("inlineCode",{parentName:"li"},"[...path].js")," matches the structure of an archive."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"both"),": Will only fetch a single and an archive if they both match the expected url structure."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"none"),": Does not perform any checks against ",(0,r.kt)("inlineCode",{parentName:"li"},"[...path].js"),".")),(0,r.kt)("p",null,"As an example, if you are trying to have ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog")," fetch the latest posts and ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog/post-name")," fetch a single post and set ",(0,r.kt)("inlineCode",{parentName:"p"},"routeMatchStrategy")," to ",(0,r.kt)("inlineCode",{parentName:"p"},"archive"),", the ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog")," route will never work."))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7272],{3905:(e,t,n)=>{n.d(t,{Zo:()=>h,kt:()=>m});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=a.createContext({}),p=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},h=function(e){var t=p(e.components);return a.createElement(l.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,h=i(e,["components","mdxType","originalType","parentName"]),c=p(n),d=r,m=c["".concat(l,".").concat(d)]||c[d]||u[d]||o;return n?a.createElement(m,s(s({ref:t},h),{},{components:n})):a.createElement(m,s({ref:t},h))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,s=new Array(o);s[0]=d;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[c]="string"==typeof e?e:r,s[1]=i;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>c,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var a=n(7462),r=(n(7294),n(3905));const o={slug:"/data-fetching/use-post-or-posts",sidebar_position:4},s="The usePostOrPosts hook",i={unversionedId:"Data Fetching/usePostOrPosts",id:"Data Fetching/usePostOrPosts",title:"The usePostOrPosts hook",description:"This hook was introduced in @headstartwp/core@1.1.0 and @headstartwp/next@1.1.0",source:"@site/documentation/02 - Data Fetching/usePostOrPosts.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/use-post-or-posts",permalink:"/docs/learn/data-fetching/use-post-or-posts",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/usePostOrPosts.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:4,frontMatter:{slug:"/data-fetching/use-post-or-posts",sidebar_position:4},sidebar:"tutorialSidebar",previous:{title:"The useAuthorArchive Hook",permalink:"/docs/learn/data-fetching/useauthorarchive"},next:{title:"The useTerms hook",permalink:"/docs/learn/data-fetching/useterms"}},l={},p=[{value:"Basic Usage",id:"basic-usage",level:2},{value:"Return values",id:"return-values",level:3},{value:"single and archive params",id:"single-and-archive-params",level:3},{value:"priority",id:"priority",level:3},{value:"routeMatchStrategy",id:"routematchstrategy",level:3}],h={toc:p};function c(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},h,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"the-usepostorposts-hook"},"The usePostOrPosts hook"),(0,r.kt)("admonition",{type:"info"},(0,r.kt)("p",{parentName:"admonition"},"This hook was introduced in ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/core@1.1.0")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/next@1.1.0"))),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"The ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#usepostorposts"},"usePostOrPosts")," hook is the Next.js binding for the ",(0,r.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchpostorposts"},"useFetchPostOrPosts"),".")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostOrPosts")," fetch either a single post or a collection of posts based on the current path. It is useful when you want to prefix the archive and the single posts with the same prefix. E.g: /blog/post-name and /blog/news"),(0,r.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},"// src/pages/blog/[...path].js\n\nconst blogParams = {\n single: {\n postType: 'post',\n },\n archive: {\n postType: 'post',\n taxonomy: 'category',\n },\n priority: 'single',\n routeMatchStrategy: 'single',\n};\n\nconst Archive = () => {\n const { data } = usePosts(blogParams.archive);\n\n return (\n <>\n

Blog Page

\n
    \n {data.posts.map((post) => (\n
  • \n {post.title.rendered}\n
  • \n ))}\n
\n \n );\n};\n\nconst PageContent = ({ params }) => {\n const { data } = usePost(params);\n\n return (\n <>\n

\n \n

\n \n \n );\n};\n\n\nconst BlogPage = () => {\n const { isArchive } = usePostOrPosts(blogParams);\n\n if (isArchive) {\n return ;\n }\n\n return ;\n};\n\nexport async function getServerSideProps(context) {\n try {\n const settledPromises = await resolveBatch([\n {\n func: fetchHookData(usePostOrPosts.fetcher(), context, { params: blogParams }),\n },\n ]);\n\n return addHookData(settledPromises, {});\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("p",null,"The above route will match the following URLs:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"/blog/","[category]"),(0,r.kt)("li",{parentName:"ul"},"/blog/","[category]","/page/","[page]"),(0,r.kt)("li",{parentName:"ul"},"/blog/","[category]","/","[post-name]"," (this route will only work if the ",(0,r.kt)("inlineCode",{parentName:"li"},"post.link")," property matches this structure in WP)"),(0,r.kt)("li",{parentName:"ul"},"/blog/","[post-name]"," (this route will only work if the ",(0,r.kt)("inlineCode",{parentName:"li"},"post.link")," property matches this structure in WP)")),(0,r.kt)("h3",{id:"return-values"},"Return values"),(0,r.kt)("p",null,"This hook returns the following things:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"isArchive"),": true if the resulting data is for an archive"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"isSingle"),": true if the resulting data is for a single post"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"post"),": if isSingle is true, will hold the data for a single post"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"posts"),": if isArchive is true, will hold the data for an archive")),(0,r.kt)("p",null,"When using the ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostOrPosts")," hook you can also use ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," without needing to make additional fetch calls. The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostOrPosts")," hook will populate the cache for ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts"),". That is why in the example on the page, the actual data is pulled from ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts"),"."),(0,r.kt)("h3",{id:"single-and-archive-params"},"single and archive params"),(0,r.kt)("p",null,"The route above is going to try to fetch either a single post or a post archive based on the current URL. The parameters passed to ",(0,r.kt)("inlineCode",{parentName:"p"},"single")," are the ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," parameters and the ",(0,r.kt)("inlineCode",{parentName:"p"},"archive")," params are the ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," params."),(0,r.kt)("h3",{id:"priority"},"priority"),(0,r.kt)("p",null,"The possible values for ",(0,r.kt)("inlineCode",{parentName:"p"},"priority")," are ",(0,r.kt)("inlineCode",{parentName:"p"},"single")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"archive"),". This setting exists to prioritize one strategy over the other when there are URL collisions. In the example on this page, there could be a slug collision where a post exists with the slug of a category. In that case, the ",(0,r.kt)("inlineCode",{parentName:"p"},"priority")," setting will dictate which one is going to be used."),(0,r.kt)("h3",{id:"routematchstrategy"},"routeMatchStrategy"),(0,r.kt)("p",null,"This setting controls whether ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," should match the fetch strategy. The possible values are ",(0,r.kt)("inlineCode",{parentName:"p"},"none")," (default), ",(0,r.kt)("inlineCode",{parentName:"p"},"single"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"archive")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"both"),"."),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"single"),": Will only fetch a single post if ",(0,r.kt)("inlineCode",{parentName:"li"},"[...path].js")," matches the structure of a single."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"archive"),": Will only fetch an archive if ",(0,r.kt)("inlineCode",{parentName:"li"},"[...path].js")," matches the structure of an archive."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"both"),": Will only fetch a single and an archive if they both match the expected url structure."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"none"),": Does not perform any checks against ",(0,r.kt)("inlineCode",{parentName:"li"},"[...path].js"),".")),(0,r.kt)("p",null,"As an example, if you are trying to have ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog")," fetch the latest posts and ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog/post-name")," fetch a single post and set ",(0,r.kt)("inlineCode",{parentName:"p"},"routeMatchStrategy")," to ",(0,r.kt)("inlineCode",{parentName:"p"},"archive"),", the ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog")," route will never work."))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6eeb730f.1e34ea0d.js b/assets/js/6eeb730f.6b29cf41.js similarity index 95% rename from assets/js/6eeb730f.1e34ea0d.js rename to assets/js/6eeb730f.6b29cf41.js index d683a88fe..ded024a41 100644 --- a/assets/js/6eeb730f.1e34ea0d.js +++ b/assets/js/6eeb730f.6b29cf41.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7251],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var s=r.createContext({}),d=function(e){var t=r.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return r.createElement(s.Provider,{value:t},e.children)},m="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,s=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),m=d(a),k=n,h=m["".concat(s,".").concat(k)]||m[k]||c[k]||i;return a?r.createElement(h,p(p({ref:t},o),{},{components:a})):r.createElement(h,p({ref:t},o))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=k;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[m]="string"==typeof e?e:n,p[1]=l;for(var d=2;d{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>m,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.TaxonomyTermsStrategy",title:"Class: TaxonomyTermsStrategy",sidebar_label:"@headstartwp/core.TaxonomyTermsStrategy",custom_edit_url:null},p=void 0,l={unversionedId:"classes/headstartwp_core.TaxonomyTermsStrategy",id:"classes/headstartwp_core.TaxonomyTermsStrategy",title:"Class: TaxonomyTermsStrategy",description:"@headstartwp/core.TaxonomyTermsStrategy",source:"@site/docs/classes/headstartwp_core.TaxonomyTermsStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.TaxonomyTermsStrategy",permalink:"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.TaxonomyTermsStrategy",title:"Class: TaxonomyTermsStrategy",sidebar_label:"@headstartwp/core.TaxonomyTermsStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.SinglePostFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"},next:{title:"@headstartwp/core.Text",permalink:"/docs/api/classes/headstartwp_core.Text"}},s={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"defaultTaxonomy",id:"defaulttaxonomy",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-5",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-20",level:4}],o={toc:d};function m(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".TaxonomyTermsStrategy"),(0,n.kt)("p",null,"This fetch strategy does not support extracting url params from the url"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"TaxonomyTermsStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new TaxonomyTermsStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L115"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:115")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L105"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:105")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaulttaxonomy"},"defaultTaxonomy"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultTaxonomy"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"'category'")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L103"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:103")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L110"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:110")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Builds the final endpoint URL based on the passed parameters"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to add to the request")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The endpoint URL."),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L122"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:122")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"The default fetcher function"),(0,n.kt)("p",null,"The default fetcher function handles authentication headers and errors from the API."),(0,n.kt)("p",null,"A custom strategy can override this function to run additional logic before or after the fetch call"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetcher options")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L138"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:138")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L146"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:146")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L404"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:404")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L227"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:227")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L369"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:369")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-3"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L105"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:105")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-4"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L109"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:109")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"overrides-5"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L113"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:113")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L327"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L191"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:191")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L379"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:379")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L219"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:219")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L150"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:150")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L146"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:146")))}m.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7251],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var d=r.createContext({}),s=function(e){var t=r.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=s(e.components);return r.createElement(d.Provider,{value:t},e.children)},m="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),m=s(a),k=n,h=m["".concat(d,".").concat(k)]||m[k]||c[k]||i;return a?r.createElement(h,p(p({ref:t},o),{},{components:a})):r.createElement(h,p({ref:t},o))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=k;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l[m]="string"==typeof e?e:n,p[1]=l;for(var s=2;s{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>m,frontMatter:()=>i,metadata:()=>l,toc:()=>s});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.TaxonomyTermsStrategy",title:"Class: TaxonomyTermsStrategy",sidebar_label:"@headstartwp/core.TaxonomyTermsStrategy",custom_edit_url:null},p=void 0,l={unversionedId:"classes/headstartwp_core.TaxonomyTermsStrategy",id:"classes/headstartwp_core.TaxonomyTermsStrategy",title:"Class: TaxonomyTermsStrategy",description:"@headstartwp/core.TaxonomyTermsStrategy",source:"@site/docs/classes/headstartwp_core.TaxonomyTermsStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.TaxonomyTermsStrategy",permalink:"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.TaxonomyTermsStrategy",title:"Class: TaxonomyTermsStrategy",sidebar_label:"@headstartwp/core.TaxonomyTermsStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.SinglePostFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"},next:{title:"@headstartwp/core.Text",permalink:"/docs/api/classes/headstartwp_core.Text"}},d={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"defaultTaxonomy",id:"defaulttaxonomy",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-5",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-20",level:4}],o={toc:s};function m(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".TaxonomyTermsStrategy"),(0,n.kt)("p",null,"This fetch strategy does not support extracting url params from the url"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"TaxonomyTermsStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new TaxonomyTermsStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L115"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:115")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L105"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:105")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaulttaxonomy"},"defaultTaxonomy"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultTaxonomy"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"'category'")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L103"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:103")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L110"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:110")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Builds the final endpoint URL based on the passed parameters"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to add to the request")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The endpoint URL."),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L122"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:122")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"The default fetcher function"),(0,n.kt)("p",null,"The default fetcher function handles authentication headers and errors from the API."),(0,n.kt)("p",null,"A custom strategy can override this function to run additional logic before or after the fetch call"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetcher options")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L138"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:138")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L146"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:146")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L404"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:404")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L227"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:227")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L369"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:369")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-3"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L105"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:105")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-4"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L109"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:109")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"overrides-5"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L113"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:113")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L327"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L191"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:191")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L379"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:379")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L219"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:219")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L150"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:150")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L146"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:146")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6ef049a8.4b0a6f72.js b/assets/js/6ef049a8.226af2d0.js similarity index 90% rename from assets/js/6ef049a8.4b0a6f72.js rename to assets/js/6ef049a8.226af2d0.js index 076aef0ee..12ae96f86 100644 --- a/assets/js/6ef049a8.4b0a6f72.js +++ b/assets/js/6ef049a8.226af2d0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1726],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),u=n,h=s["".concat(p,".").concat(u)]||s[u]||k[u]||i;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=u;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.AudioBlockProps",title:"Interface: AudioBlockProps",sidebar_label:"@headstartwp/core.react.AudioBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.AudioBlockProps",id:"interfaces/headstartwp_core.react.AudioBlockProps",title:"Interface: AudioBlockProps",description:"@headstartwp/core.react.AudioBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.AudioBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.AudioBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.AudioBlockProps",title:"Interface: AudioBlockProps",sidebar_label:"@headstartwp/core.react.AudioBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.YoastSEOIntegration",permalink:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration"},next:{title:"@headstartwp/core.react.BlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockAttributes"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"autoplay",id:"autoplay",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"caption",id:"caption",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"loop",id:"loop",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"preload",id:"preload",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"src",id:"src",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-11",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".AudioBlockProps"),(0,n.kt)("p",null,"The interface for components rendered by ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#audioblock"},"AudioBlock")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"AudioBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"autoplay"},"autoplay"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"autoplay"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Whether the audio should be autoplayable"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/AudioBlock.tsx#L19"},"packages/core/src/react/blocks/AudioBlock.tsx:19")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"caption"},"caption"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"caption"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Audio caption"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/AudioBlock.tsx#L24"},"packages/core/src/react/blocks/AudioBlock.tsx:24")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loop"},"loop"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"loop"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Whether the audio should be played in a loop"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/AudioBlock.tsx#L29"},"packages/core/src/react/blocks/AudioBlock.tsx:29")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"preload"},"preload"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"preload"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Whether to preload the audio or not"),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/AudioBlock.tsx#L34"},"packages/core/src/react/blocks/AudioBlock.tsx:34")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"src"},"src"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"src"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The audio source URL."),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/AudioBlock.tsx#L14"},"packages/core/src/react/blocks/AudioBlock.tsx:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1726],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),d=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),s=d(a),u=n,h=s["".concat(p,".").concat(u)]||s[u]||k[u]||i;return a?r.createElement(h,l(l({ref:t},c),{},{components:a})):r.createElement(h,l({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=u;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.AudioBlockProps",title:"Interface: AudioBlockProps",sidebar_label:"@headstartwp/core.react.AudioBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.AudioBlockProps",id:"interfaces/headstartwp_core.react.AudioBlockProps",title:"Interface: AudioBlockProps",description:"@headstartwp/core.react.AudioBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.AudioBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.AudioBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.AudioBlockProps",title:"Interface: AudioBlockProps",sidebar_label:"@headstartwp/core.react.AudioBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.YoastSEOIntegration",permalink:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration"},next:{title:"@headstartwp/core.react.BlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockAttributes"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"autoplay",id:"autoplay",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"caption",id:"caption",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"loop",id:"loop",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"preload",id:"preload",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"src",id:"src",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-11",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".AudioBlockProps"),(0,n.kt)("p",null,"The interface for components rendered by ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#audioblock"},"AudioBlock")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"AudioBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"autoplay"},"autoplay"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"autoplay"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Whether the audio should be autoplayable"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/AudioBlock.tsx#L19"},"packages/core/src/react/blocks/AudioBlock.tsx:19")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"caption"},"caption"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"caption"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Audio caption"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/AudioBlock.tsx#L24"},"packages/core/src/react/blocks/AudioBlock.tsx:24")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loop"},"loop"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"loop"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Whether the audio should be played in a loop"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/AudioBlock.tsx#L29"},"packages/core/src/react/blocks/AudioBlock.tsx:29")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"preload"},"preload"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"preload"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Whether to preload the audio or not"),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/AudioBlock.tsx#L34"},"packages/core/src/react/blocks/AudioBlock.tsx:34")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"src"},"src"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"src"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The audio source URL."),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/AudioBlock.tsx#L14"},"packages/core/src/react/blocks/AudioBlock.tsx:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/704c2a10.f9cc4116.js b/assets/js/704c2a10.538865f3.js similarity index 98% rename from assets/js/704c2a10.f9cc4116.js rename to assets/js/704c2a10.538865f3.js index 1db47bc52..9a5b0470c 100644 --- a/assets/js/704c2a10.f9cc4116.js +++ b/assets/js/704c2a10.538865f3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2779],{3905:(e,t,r)=>{r.d(t,{Zo:()=>i,kt:()=>f});var a=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function n(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function c(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var p=a.createContext({}),s=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):c(c({},t),e)),r},i=function(e){var t=s(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,o=e.mdxType,n=e.originalType,p=e.parentName,i=l(e,["components","mdxType","originalType","parentName"]),d=s(r),m=o,f=d["".concat(p,".").concat(m)]||d[m]||u[m]||n;return r?a.createElement(f,c(c({ref:t},i),{},{components:r})):a.createElement(f,c({ref:t},i))}));function f(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var n=r.length,c=new Array(n);c[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[d]="string"==typeof e?e:o,c[1]=l;for(var s=2;s{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>c,default:()=>d,frontMatter:()=>n,metadata:()=>l,toc:()=>s});var a=r(7462),o=(r(7294),r(3905));const n={id:"headstartwp_core.react.HtmlDecodeProps",title:"Interface: HtmlDecodeProps",sidebar_label:"@headstartwp/core.react.HtmlDecodeProps",custom_edit_url:null},c=void 0,l={unversionedId:"interfaces/headstartwp_core.react.HtmlDecodeProps",id:"interfaces/headstartwp_core.react.HtmlDecodeProps",title:"Interface: HtmlDecodeProps",description:"@headstartwp/core.react.HtmlDecodeProps",source:"@site/docs/interfaces/headstartwp_core.react.HtmlDecodeProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.HtmlDecodeProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.HtmlDecodeProps",title:"Interface: HtmlDecodeProps",sidebar_label:"@headstartwp/core.react.HtmlDecodeProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.HookResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},next:{title:"@headstartwp/core.react.IAudioBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock"}},p={},s=[{value:"Properties",id:"properties",level:2},{value:"html",id:"html",level:3},{value:"Defined in",id:"defined-in",level:4}],i={toc:s};function d(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,a.Z)({},i,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,o.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".HtmlDecodeProps"),(0,o.kt)("h2",{id:"properties"},"Properties"),(0,o.kt)("h3",{id:"html"},"html"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"html"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,"The string with html entities to decode"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-jsx"},'\n')),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/HtmlDecoder.tsx#L13"},"packages/core/src/react/components/HtmlDecoder.tsx:13")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2779],{3905:(e,t,r)=>{r.d(t,{Zo:()=>i,kt:()=>f});var a=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function n(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function c(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var p=a.createContext({}),s=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):c(c({},t),e)),r},i=function(e){var t=s(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,o=e.mdxType,n=e.originalType,p=e.parentName,i=l(e,["components","mdxType","originalType","parentName"]),d=s(r),m=o,f=d["".concat(p,".").concat(m)]||d[m]||u[m]||n;return r?a.createElement(f,c(c({ref:t},i),{},{components:r})):a.createElement(f,c({ref:t},i))}));function f(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var n=r.length,c=new Array(n);c[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[d]="string"==typeof e?e:o,c[1]=l;for(var s=2;s{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>c,default:()=>d,frontMatter:()=>n,metadata:()=>l,toc:()=>s});var a=r(7462),o=(r(7294),r(3905));const n={id:"headstartwp_core.react.HtmlDecodeProps",title:"Interface: HtmlDecodeProps",sidebar_label:"@headstartwp/core.react.HtmlDecodeProps",custom_edit_url:null},c=void 0,l={unversionedId:"interfaces/headstartwp_core.react.HtmlDecodeProps",id:"interfaces/headstartwp_core.react.HtmlDecodeProps",title:"Interface: HtmlDecodeProps",description:"@headstartwp/core.react.HtmlDecodeProps",source:"@site/docs/interfaces/headstartwp_core.react.HtmlDecodeProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.HtmlDecodeProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.HtmlDecodeProps",title:"Interface: HtmlDecodeProps",sidebar_label:"@headstartwp/core.react.HtmlDecodeProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.HookResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},next:{title:"@headstartwp/core.react.IAudioBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock"}},p={},s=[{value:"Properties",id:"properties",level:2},{value:"html",id:"html",level:3},{value:"Defined in",id:"defined-in",level:4}],i={toc:s};function d(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,a.Z)({},i,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,o.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".HtmlDecodeProps"),(0,o.kt)("h2",{id:"properties"},"Properties"),(0,o.kt)("h3",{id:"html"},"html"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"html"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,"The string with html entities to decode"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-jsx"},'\n')),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/HtmlDecoder.tsx#L13"},"packages/core/src/react/components/HtmlDecoder.tsx:13")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7272e25f.aa3d5c59.js b/assets/js/7272e25f.8e74f7a2.js similarity index 96% rename from assets/js/7272e25f.aa3d5c59.js rename to assets/js/7272e25f.8e74f7a2.js index 475e82b08..25e028688 100644 --- a/assets/js/7272e25f.aa3d5c59.js +++ b/assets/js/7272e25f.8e74f7a2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7895],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},s=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),d=c(r),m=n,h=d["".concat(p,".").concat(m)]||d[m]||k[m]||i;return r?a.createElement(h,o(o({ref:t},s),{},{components:r})):a.createElement(h,o({ref:t},s))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[d]="string"==typeof e?e:n,o[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.ButtonsBlockProps",title:"Interface: ButtonsBlockProps",sidebar_label:"@headstartwp/core.react.ButtonsBlockProps",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.ButtonsBlockProps",id:"interfaces/headstartwp_core.react.ButtonsBlockProps",title:"Interface: ButtonsBlockProps",description:"@headstartwp/core.react.ButtonsBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ButtonsBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ButtonsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ButtonsBlockProps",title:"Interface: ButtonsBlockProps",sidebar_label:"@headstartwp/core.react.ButtonsBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ButtonBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},next:{title:"@headstartwp/core.react.CodeBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ButtonsBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ButtonsBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7895],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},s=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),d=c(r),m=n,h=d["".concat(p,".").concat(m)]||d[m]||k[m]||i;return r?a.createElement(h,o(o({ref:t},s),{},{components:r})):a.createElement(h,o({ref:t},s))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[d]="string"==typeof e?e:n,o[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.ButtonsBlockProps",title:"Interface: ButtonsBlockProps",sidebar_label:"@headstartwp/core.react.ButtonsBlockProps",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.ButtonsBlockProps",id:"interfaces/headstartwp_core.react.ButtonsBlockProps",title:"Interface: ButtonsBlockProps",description:"@headstartwp/core.react.ButtonsBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ButtonsBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ButtonsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ButtonsBlockProps",title:"Interface: ButtonsBlockProps",sidebar_label:"@headstartwp/core.react.ButtonsBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ButtonBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},next:{title:"@headstartwp/core.react.CodeBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ButtonsBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ButtonsBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7360f818.6f34bbed.js b/assets/js/7360f818.46134336.js similarity index 91% rename from assets/js/7360f818.6f34bbed.js rename to assets/js/7360f818.46134336.js index 4f76af77e..b93a28e8b 100644 --- a/assets/js/7360f818.6f34bbed.js +++ b/assets/js/7360f818.46134336.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6875],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var s=n.createContext({}),l=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),c=l(a),f=i,k=c["".concat(s,".").concat(f)]||c[f]||h[f]||r;return a?n.createElement(k,p(p({ref:t},o),{},{components:a})):n.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=a.length,p=new Array(r);p[0]=f;var d={};for(var s in t)hasOwnProperty.call(t,s)&&(d[s]=t[s]);d.originalType=e,d[c]="string"==typeof e?e:i,p[1]=d;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var n=a(7462),i=(a(7294),a(3905));const r={id:"headstartwp_core.PageEntity",title:"Interface: PageEntity",sidebar_label:"@headstartwp/core.PageEntity",custom_edit_url:null},p=void 0,d={unversionedId:"interfaces/headstartwp_core.PageEntity",id:"interfaces/headstartwp_core.PageEntity",title:"Interface: PageEntity",description:"@headstartwp/core.PageEntity",source:"@site/docs/interfaces/headstartwp_core.PageEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PageEntity",permalink:"/docs/api/interfaces/headstartwp_core.PageEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PageEntity",title:"Interface: PageEntity",sidebar_label:"@headstartwp/core.PageEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.MenuItemEntity",permalink:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},next:{title:"@headstartwp/core.PageInfo",permalink:"/docs/api/interfaces/headstartwp_core.PageInfo"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"author",id:"author",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"comment_status",id:"comment_status",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"content",id:"content",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"date",id:"date",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"excerpt",id:"excerpt",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"featured_media",id:"featured_media",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"guid",id:"guid",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"link",id:"link",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"menu_order",id:"menu_order",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"modified",id:"modified",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"modified_gmt",id:"modified_gmt",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"parent",id:"parent",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"ping_status",id:"ping_status",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"slug",id:"slug",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"status",id:"status",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"template",id:"template",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"terms",id:"terms",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"type",id:"type",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-24",level:4}],o={toc:l};function c(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PageEntity"),(0,i.kt)("p",null,"Interface for entities from the /wp/v2/pages endpoint."),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PostTypeEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"PageEntity"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"_embedded"},"_","embedded"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"author")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wp:term")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]")))),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#_embedded"},"_embedded")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L98"},"packages/core/src/data/types/entities.ts:98")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"author"},"author"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"author"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#author"},"author")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L94"},"packages/core/src/data/types/entities.ts:94")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"comment_status"},"comment","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"comment","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not comments are open on the object."),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#comment_status"},"comment_status")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L106"},"packages/core/src/data/types/entities.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"content"},"content"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"content"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The content for the object."),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L209"},"packages/core/src/data/types/entities.ts:209")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date"},"date"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date"},"date")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L42"},"packages/core/src/data/types/entities.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, as GMT."),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date_gmt"},"date_gmt")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L47"},"packages/core/src/data/types/entities.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"excerpt"},"excerpt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"excerpt"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The excerpt for the object."),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L214"},"packages/core/src/data/types/entities.ts:214")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"featured_media"},"featured","_","media"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"featured","_","media"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The ID of the featured media for the object."),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L234"},"packages/core/src/data/types/entities.ts:234")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"guid"},"guid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"guid"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The globally unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#guid"},"guid")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L52"},"packages/core/src/data/types/entities.ts:52")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#id"},"id")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L67"},"packages/core/src/data/types/entities.ts:67")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"link"},"link"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"link"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the object."),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#link"},"link")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L72"},"packages/core/src/data/types/entities.ts:72")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"menu_order"},"menu","_","order"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"menu","_","order"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The order of the object in relation to other object of its type."),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L219"},"packages/core/src/data/types/entities.ts:219")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"meta"},"meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"meta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("p",null,"Meta fields."),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L224"},"packages/core/src/data/types/entities.ts:224")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified"},"modified"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified"},"modified")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L57"},"packages/core/src/data/types/entities.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified_gmt"},"modified","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, as GMT."),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified_gmt"},"modified_gmt")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L62"},"packages/core/src/data/types/entities.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"parent"},"parent"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"parent"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The ID for the parent of the object."),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L204"},"packages/core/src/data/types/entities.ts:204")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ping_status"},"ping","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ping","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not the object can be pinged."),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#ping_status"},"ping_status")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L111"},"packages/core/src/data/types/entities.ts:111")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"slug"},"slug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"slug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"An alphanumeric identifier for the object unique to its type."),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#slug"},"slug")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L77"},"packages/core/src/data/types/entities.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"private"')),(0,i.kt)("p",null,"A named status for the object."),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#status"},"status")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L82"},"packages/core/src/data/types/entities.ts:82")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"template"},"template"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"template"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The theme file to use to display the object."),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L229"},"packages/core/src/data/types/entities.ts:229")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"terms"},"terms"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"terms"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#terms"},"terms")),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L96"},"packages/core/src/data/types/entities.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The title for the object."),(0,i.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#title"},"title")),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L92"},"packages/core/src/data/types/entities.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Type of Post for the object."),(0,i.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#type"},"type")),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L87"},"packages/core/src/data/types/entities.ts:87")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head"},"yoast_head")),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L114"},"packages/core/src/data/types/entities.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head_json"},"yoast_head_json")),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L113"},"packages/core/src/data/types/entities.ts:113")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6875],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>f});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var s=n.createContext({}),l=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),c=l(a),k=i,f=c["".concat(s,".").concat(k)]||c[k]||h[k]||r;return a?n.createElement(f,p(p({ref:t},o),{},{components:a})):n.createElement(f,p({ref:t},o))}));function f(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=a.length,p=new Array(r);p[0]=k;var d={};for(var s in t)hasOwnProperty.call(t,s)&&(d[s]=t[s]);d.originalType=e,d[c]="string"==typeof e?e:i,p[1]=d;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var n=a(7462),i=(a(7294),a(3905));const r={id:"headstartwp_core.PageEntity",title:"Interface: PageEntity",sidebar_label:"@headstartwp/core.PageEntity",custom_edit_url:null},p=void 0,d={unversionedId:"interfaces/headstartwp_core.PageEntity",id:"interfaces/headstartwp_core.PageEntity",title:"Interface: PageEntity",description:"@headstartwp/core.PageEntity",source:"@site/docs/interfaces/headstartwp_core.PageEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PageEntity",permalink:"/docs/api/interfaces/headstartwp_core.PageEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PageEntity",title:"Interface: PageEntity",sidebar_label:"@headstartwp/core.PageEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.MenuItemEntity",permalink:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},next:{title:"@headstartwp/core.PageInfo",permalink:"/docs/api/interfaces/headstartwp_core.PageInfo"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"author",id:"author",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"comment_status",id:"comment_status",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"content",id:"content",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"date",id:"date",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"excerpt",id:"excerpt",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"featured_media",id:"featured_media",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"guid",id:"guid",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"link",id:"link",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"menu_order",id:"menu_order",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"modified",id:"modified",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"modified_gmt",id:"modified_gmt",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"parent",id:"parent",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"ping_status",id:"ping_status",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"slug",id:"slug",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"status",id:"status",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"template",id:"template",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"terms",id:"terms",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"type",id:"type",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-24",level:4}],o={toc:l};function c(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PageEntity"),(0,i.kt)("p",null,"Interface for entities from the /wp/v2/pages endpoint."),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PostTypeEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"PageEntity"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"_embedded"},"_","embedded"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"author")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wp:term")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]")))),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#_embedded"},"_embedded")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L98"},"packages/core/src/data/types/entities.ts:98")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"author"},"author"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"author"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#author"},"author")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L94"},"packages/core/src/data/types/entities.ts:94")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"comment_status"},"comment","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"comment","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not comments are open on the object."),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#comment_status"},"comment_status")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L106"},"packages/core/src/data/types/entities.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"content"},"content"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"content"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The content for the object."),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L209"},"packages/core/src/data/types/entities.ts:209")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date"},"date"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date"},"date")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L42"},"packages/core/src/data/types/entities.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, as GMT."),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date_gmt"},"date_gmt")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L47"},"packages/core/src/data/types/entities.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"excerpt"},"excerpt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"excerpt"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The excerpt for the object."),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L214"},"packages/core/src/data/types/entities.ts:214")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"featured_media"},"featured","_","media"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"featured","_","media"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The ID of the featured media for the object."),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L234"},"packages/core/src/data/types/entities.ts:234")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"guid"},"guid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"guid"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The globally unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#guid"},"guid")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L52"},"packages/core/src/data/types/entities.ts:52")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#id"},"id")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L67"},"packages/core/src/data/types/entities.ts:67")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"link"},"link"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"link"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the object."),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#link"},"link")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L72"},"packages/core/src/data/types/entities.ts:72")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"menu_order"},"menu","_","order"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"menu","_","order"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The order of the object in relation to other object of its type."),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L219"},"packages/core/src/data/types/entities.ts:219")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"meta"},"meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"meta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("p",null,"Meta fields."),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L224"},"packages/core/src/data/types/entities.ts:224")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified"},"modified"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified"},"modified")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L57"},"packages/core/src/data/types/entities.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified_gmt"},"modified","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, as GMT."),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified_gmt"},"modified_gmt")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L62"},"packages/core/src/data/types/entities.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"parent"},"parent"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"parent"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The ID for the parent of the object."),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L204"},"packages/core/src/data/types/entities.ts:204")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ping_status"},"ping","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ping","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not the object can be pinged."),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#ping_status"},"ping_status")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L111"},"packages/core/src/data/types/entities.ts:111")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"slug"},"slug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"slug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"An alphanumeric identifier for the object unique to its type."),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#slug"},"slug")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L77"},"packages/core/src/data/types/entities.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"private"')),(0,i.kt)("p",null,"A named status for the object."),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#status"},"status")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L82"},"packages/core/src/data/types/entities.ts:82")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"template"},"template"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"template"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The theme file to use to display the object."),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L229"},"packages/core/src/data/types/entities.ts:229")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"terms"},"terms"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"terms"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#terms"},"terms")),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L96"},"packages/core/src/data/types/entities.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The title for the object."),(0,i.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#title"},"title")),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L92"},"packages/core/src/data/types/entities.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Type of Post for the object."),(0,i.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#type"},"type")),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L87"},"packages/core/src/data/types/entities.ts:87")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head"},"yoast_head")),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L114"},"packages/core/src/data/types/entities.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head_json"},"yoast_head_json")),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L113"},"packages/core/src/data/types/entities.ts:113")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/74bdc397.87478ed7.js b/assets/js/74bdc397.ef3d2d79.js similarity index 89% rename from assets/js/74bdc397.87478ed7.js rename to assets/js/74bdc397.ef3d2d79.js index eb2cf57df..4ddfd4821 100644 --- a/assets/js/74bdc397.87478ed7.js +++ b/assets/js/74bdc397.ef3d2d79.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[918],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>u});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),c=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},l=function(e){var t=c(e.components);return a.createElement(s.Provider,{value:t},e.children)},d="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,s=e.parentName,l=p(e,["components","mdxType","originalType","parentName"]),d=c(r),k=n,u=d["".concat(s,".").concat(k)]||d[k]||h[k]||o;return r?a.createElement(u,i(i({ref:t},l),{},{components:r})):a.createElement(u,i({ref:t},l))}));function u(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,i=new Array(o);i[0]=k;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[d]="string"==typeof e?e:n,i[1]=p;for(var c=2;c{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>p,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.useSearchResponse",title:"Interface: useSearchResponse",sidebar_label:"@headstartwp/core.react.useSearchResponse",custom_edit_url:null},i=void 0,p={unversionedId:"interfaces/headstartwp_core.react.useSearchResponse",id:"interfaces/headstartwp_core.react.useSearchResponse",title:"Interface: useSearchResponse",description:"@headstartwp/core.react.useSearchResponse",source:"@site/docs/interfaces/headstartwp_core.react.useSearchResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.useSearchResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.useSearchResponse",title:"Interface: useSearchResponse",sidebar_label:"@headstartwp/core.react.useSearchResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.usePostsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},next:{title:"@headstartwp/core.react.useTermsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"}},s={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],l={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".useSearchResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"useSearchResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"pageInfo")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"posts")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"queriedObject")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject")))))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/useFetchSearch.ts#L18"},"packages/core/src/react/hooks/useFetchSearch.ts:18")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[918],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>u});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),c=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(s.Provider,{value:t},e.children)},l="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,s=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),l=c(r),k=n,u=l["".concat(s,".").concat(k)]||l[k]||h[k]||o;return r?a.createElement(u,i(i({ref:t},d),{},{components:r})):a.createElement(u,i({ref:t},d))}));function u(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,i=new Array(o);i[0]=k;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[l]="string"==typeof e?e:n,i[1]=p;for(var c=2;c{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>p,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.useSearchResponse",title:"Interface: useSearchResponse",sidebar_label:"@headstartwp/core.react.useSearchResponse",custom_edit_url:null},i=void 0,p={unversionedId:"interfaces/headstartwp_core.react.useSearchResponse",id:"interfaces/headstartwp_core.react.useSearchResponse",title:"Interface: useSearchResponse",description:"@headstartwp/core.react.useSearchResponse",source:"@site/docs/interfaces/headstartwp_core.react.useSearchResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.useSearchResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.useSearchResponse",title:"Interface: useSearchResponse",sidebar_label:"@headstartwp/core.react.useSearchResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.usePostsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},next:{title:"@headstartwp/core.react.useTermsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"}},s={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],d={toc:c};function l(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".useSearchResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"useSearchResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"pageInfo")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"posts")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"queriedObject")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject")))))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/useFetchSearch.ts#L18"},"packages/core/src/react/hooks/useFetchSearch.ts:18")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}l.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/76bd5e23.b487bb5d.js b/assets/js/76bd5e23.827d15f2.js similarity index 96% rename from assets/js/76bd5e23.b487bb5d.js rename to assets/js/76bd5e23.827d15f2.js index 4003c50fe..6dcd1042b 100644 --- a/assets/js/76bd5e23.b487bb5d.js +++ b/assets/js/76bd5e23.827d15f2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9621],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function o(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),c=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},d=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},s="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),k=r,h=s["".concat(p,".").concat(k)]||s[k]||m[k]||l;return a?n.createElement(h,o(o({ref:t},d),{},{components:a})):n.createElement(h,o({ref:t},d))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,o=new Array(l);o[0]=k;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:r,o[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>l,metadata:()=>i,toc:()=>c});var n=a(7462),r=(a(7294),a(3905));const l={id:"headstartwp_core.react.IColumnsBlock",title:"Interface: IColumnsBlock",sidebar_label:"@headstartwp/core.react.IColumnsBlock",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IColumnsBlock",id:"interfaces/headstartwp_core.react.IColumnsBlock",title:"Interface: IColumnsBlock",description:"@headstartwp/core.react.IColumnsBlock",source:"@site/docs/interfaces/headstartwp_core.react.IColumnsBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IColumnsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IColumnsBlock",title:"Interface: IColumnsBlock",sidebar_label:"@headstartwp/core.react.IColumnsBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IColumnBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock"},next:{title:"@headstartwp/core.react.ICoverBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ICoverBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IColumnsBlock"),(0,r.kt)("p",null,"The common interface for a block transform component"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnsBlockProps")),">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IColumnsBlock"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classname"},"className"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"component"},"component"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"component"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnsBlockProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnsBlockProps")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9621],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function o(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),c=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},d=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},s="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),k=r,h=s["".concat(p,".").concat(k)]||s[k]||m[k]||l;return a?n.createElement(h,o(o({ref:t},d),{},{components:a})):n.createElement(h,o({ref:t},d))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,o=new Array(l);o[0]=k;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:r,o[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>l,metadata:()=>i,toc:()=>c});var n=a(7462),r=(a(7294),a(3905));const l={id:"headstartwp_core.react.IColumnsBlock",title:"Interface: IColumnsBlock",sidebar_label:"@headstartwp/core.react.IColumnsBlock",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IColumnsBlock",id:"interfaces/headstartwp_core.react.IColumnsBlock",title:"Interface: IColumnsBlock",description:"@headstartwp/core.react.IColumnsBlock",source:"@site/docs/interfaces/headstartwp_core.react.IColumnsBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IColumnsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IColumnsBlock",title:"Interface: IColumnsBlock",sidebar_label:"@headstartwp/core.react.IColumnsBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IColumnBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock"},next:{title:"@headstartwp/core.react.ICoverBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ICoverBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IColumnsBlock"),(0,r.kt)("p",null,"The common interface for a block transform component"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnsBlockProps")),">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IColumnsBlock"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classname"},"className"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"component"},"component"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"component"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnsBlockProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnsBlockProps")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7721a5b2.3536ebd6.js b/assets/js/7721a5b2.efd3fd50.js similarity index 99% rename from assets/js/7721a5b2.3536ebd6.js rename to assets/js/7721a5b2.efd3fd50.js index 9b6cde5f7..b71c7dcf0 100644 --- a/assets/js/7721a5b2.3536ebd6.js +++ b/assets/js/7721a5b2.efd3fd50.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5182],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>m});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var l=n.createContext({}),p=function(e){var t=n.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},c=function(e){var t=p(e.components);return n.createElement(l.Provider,{value:t},e.children)},u="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),u=p(a),d=r,m=u["".concat(l,".").concat(d)]||u[d]||h[d]||o;return a?n.createElement(m,i(i({ref:t},c),{},{components:a})):n.createElement(m,i({ref:t},c))}));function m(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=a.length,i=new Array(o);i[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[u]="string"==typeof e?e:r,i[1]=s;for(var p=2;p{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var n=a(7462),r=(a(7294),a(3905));const o={slug:"/data-fetching/useposts",sidebar_position:2},i="The usePosts hook",s={unversionedId:"Data Fetching/usePosts",id:"Data Fetching/usePosts",title:"The usePosts hook",description:"The usePosts hook is the Next.js binding for the useFetchPosts.",source:"@site/documentation/02 - Data Fetching/usePosts.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/useposts",permalink:"/docs/learn/data-fetching/useposts",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/usePosts.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:2,frontMatter:{slug:"/data-fetching/useposts",sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"The usePost hook",permalink:"/docs/learn/data-fetching/usepost"},next:{title:"The useAuthorArchive Hook",permalink:"/docs/learn/data-fetching/useauthorarchive"}},l={},p=[{value:"Basic Usage",id:"basic-usage",level:2},{value:"Queried Object",id:"queried-object",level:2},{value:"Category Archive",id:"category-archive",level:2},{value:"Archive Path Matching",id:"archive-path-matching",level:2},{value:"Known limitations",id:"known-limitations",level:2}],c={toc:p};function u(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"the-useposts-hook"},"The usePosts hook"),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"The ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#useposts"},"usePosts")," hook is the Next.js binding for the ",(0,r.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchposts"},"useFetchPosts"),".")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," hook fetches a collection of WordPress posts from a registered post type. Its basic usage is very simple."),(0,r.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,r.kt)("p",null,"Assuming a ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/blog/[[...path]].js")," route with the following content."),(0,r.kt)("admonition",{type:"info"},(0,r.kt)("p",{parentName:"admonition"},"This example is using the optional catch-all route ",(0,r.kt)("inlineCode",{parentName:"p"},"[[..path]].js")," because we want the ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog")," route to be handled by the same file.")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/blog/[[...path]].js"',title:'"src/pages/blog/[[...path]].js"'},"import { usePost } from '@headstartwp/next';\n\nconst ArchivePage = () => {\n const { loading, error, data } = usePosts({ per_page: 10 });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n {data?.posts?.map((post) => (\n

{post.title.rendered}

\n ))}\n
\n );\n};\n")),(0,r.kt)("p",null,"The route will automatically render the latest 10 posts and you get pagination, category, tags and custom taxonomies filtering for free as the following paths will automatically map URL segments into REST API requests:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"/blog/page/2"),(0,r.kt)("li",{parentName:"ul"},"/blog/category/category-name"),(0,r.kt)("li",{parentName:"ul"},"/blog/tag/tag-name"),(0,r.kt)("li",{parentName:"ul"},"/blog/category/category-name/page/2")),(0,r.kt)("h2",{id:"queried-object"},"Queried Object"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," hook exposes a ",(0,r.kt)("inlineCode",{parentName:"p"},"queriedObject"),". It's similar to WordPress ",(0,r.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/reference/functions/get_queried_object/"},"get_queried_object()")," function."),(0,r.kt)("p",null,"It essentially returns what's being queried for, e.g., author or category. If the current page is querying posts within a certain author, then that author object will be populated in ",(0,r.kt)("inlineCode",{parentName:"p"},"data.queriedObject.author"),". Similarly, if the current page is querying posts from a given category ",(0,r.kt)("inlineCode",{parentName:"p"},"data.queriedObject.term")," will be populated with that category."),(0,r.kt)("p",null,"Example: "),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},"// category-name can either come from the URL or be manually specified.\nconst { data } = usePosts({ taxonomy: 'category', category: 'cat-name' });\n\nreturn (\n

Category Page: {data.queriedObject.term.name}

\n);\n")),(0,r.kt)("h2",{id:"category-archive"},"Category Archive"),(0,r.kt)("p",null,"You can use the ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," hook to create a category archive route (",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/category/[...path].js"),")."),(0,r.kt)("admonition",{type:"info"},(0,r.kt)("p",{parentName:"admonition"},"We use ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," here because ",(0,r.kt)("strong",{parentName:"p"},"we do not want")," the ",(0,r.kt)("inlineCode",{parentName:"p"},"/category")," route to render anything.")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/category/[...path].js"',title:'"src/pages/category/[...path].js"'},"import {\n usePosts,\n fetchHookData,\n addHookData,\n handleError,\n} from '@headstartwp/next';\n\nconst CategoryPage = () => {\n const { data } = usePosts({ taxonomy: 'category' });\n\n return (\n <>\n

Category Page: {data.queriedObject.term.name}

\n
    \n {data.posts.map((post) => (\n
  • \n {post.title.rendered}\n
  • \n ))}\n
\n \n \n );\n};\n")),(0,r.kt)("h2",{id:"archive-path-matching"},"Archive Path Matching"),(0,r.kt)("p",null,"When using ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts"),' to create archive pages (e.g. a category archive) you can optionally enable "archive path matching" to ensure that your archive routes match the expected permalink dictated by WordPress. Without "archive path matching", your archive routes would match as long as the last segment of the url is a valid term slug. '),(0,r.kt)("p",null,"For instance, let's take the ",(0,r.kt)("inlineCode",{parentName:"p"},"/category/[...path].js")," route above. It will match URLs like:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"/category/cat-name"),(0,r.kt)("li",{parentName:"ul"},"/category/parent-cat-name/cat-name")),(0,r.kt)("p",null,"The framework, however, does not check if ",(0,r.kt)("inlineCode",{parentName:"p"},"parent-cat-name")," is the de facto parent of cat-name, and even worse, it has no way to know (without additional rest api calls) if ",(0,r.kt)("inlineCode",{parentName:"p"},"parent-cat-name")," is even a valid category."),(0,r.kt)("p",null,"To address this, you can pass ",(0,r.kt)("inlineCode",{parentName:"p"},"matchArchivePath")," to ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," to tell the framework to check the ",(0,r.kt)("inlineCode",{parentName:"p"},"link")," property of the ",(0,r.kt)("inlineCode",{parentName:"p"},"queriedObject"),", i.e if the ",(0,r.kt)("inlineCode",{parentName:"p"},"link")," property of ",(0,r.kt)("inlineCode",{parentName:"p"},"cat-name")," returned by the ",(0,r.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/rest-api/reference/categories/#schema"},"WordPress REST API")," matches the front-end path."),(0,r.kt)("p",null,"This setting can also be enabled in ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," globally."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n // enable archive path mapping for all default taxonomies\n customTaxonomies: (defaultTaxonomies) => {\n return defaultTaxonomies.map((taxonomy) => ({ ...taxonomy, matchArchivePath: true })),\n },\n}\n")),(0,r.kt)("h2",{id:"known-limitations"},"Known limitations"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"It is not possible to fetch posts from more than one post type.")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5182],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>m});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var l=n.createContext({}),p=function(e){var t=n.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},c=function(e){var t=p(e.components);return n.createElement(l.Provider,{value:t},e.children)},u="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),u=p(a),d=r,m=u["".concat(l,".").concat(d)]||u[d]||h[d]||o;return a?n.createElement(m,i(i({ref:t},c),{},{components:a})):n.createElement(m,i({ref:t},c))}));function m(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=a.length,i=new Array(o);i[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[u]="string"==typeof e?e:r,i[1]=s;for(var p=2;p{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var n=a(7462),r=(a(7294),a(3905));const o={slug:"/data-fetching/useposts",sidebar_position:2},i="The usePosts hook",s={unversionedId:"Data Fetching/usePosts",id:"Data Fetching/usePosts",title:"The usePosts hook",description:"The usePosts hook is the Next.js binding for the useFetchPosts.",source:"@site/documentation/02 - Data Fetching/usePosts.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/useposts",permalink:"/docs/learn/data-fetching/useposts",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/usePosts.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:2,frontMatter:{slug:"/data-fetching/useposts",sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"The usePost hook",permalink:"/docs/learn/data-fetching/usepost"},next:{title:"The useAuthorArchive Hook",permalink:"/docs/learn/data-fetching/useauthorarchive"}},l={},p=[{value:"Basic Usage",id:"basic-usage",level:2},{value:"Queried Object",id:"queried-object",level:2},{value:"Category Archive",id:"category-archive",level:2},{value:"Archive Path Matching",id:"archive-path-matching",level:2},{value:"Known limitations",id:"known-limitations",level:2}],c={toc:p};function u(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"the-useposts-hook"},"The usePosts hook"),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"The ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#useposts"},"usePosts")," hook is the Next.js binding for the ",(0,r.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchposts"},"useFetchPosts"),".")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," hook fetches a collection of WordPress posts from a registered post type. Its basic usage is very simple."),(0,r.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,r.kt)("p",null,"Assuming a ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/blog/[[...path]].js")," route with the following content."),(0,r.kt)("admonition",{type:"info"},(0,r.kt)("p",{parentName:"admonition"},"This example is using the optional catch-all route ",(0,r.kt)("inlineCode",{parentName:"p"},"[[..path]].js")," because we want the ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog")," route to be handled by the same file.")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/blog/[[...path]].js"',title:'"src/pages/blog/[[...path]].js"'},"import { usePost } from '@headstartwp/next';\n\nconst ArchivePage = () => {\n const { loading, error, data } = usePosts({ per_page: 10 });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n {data?.posts?.map((post) => (\n

{post.title.rendered}

\n ))}\n
\n );\n};\n")),(0,r.kt)("p",null,"The route will automatically render the latest 10 posts and you get pagination, category, tags and custom taxonomies filtering for free as the following paths will automatically map URL segments into REST API requests:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"/blog/page/2"),(0,r.kt)("li",{parentName:"ul"},"/blog/category/category-name"),(0,r.kt)("li",{parentName:"ul"},"/blog/tag/tag-name"),(0,r.kt)("li",{parentName:"ul"},"/blog/category/category-name/page/2")),(0,r.kt)("h2",{id:"queried-object"},"Queried Object"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," hook exposes a ",(0,r.kt)("inlineCode",{parentName:"p"},"queriedObject"),". It's similar to WordPress ",(0,r.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/reference/functions/get_queried_object/"},"get_queried_object()")," function."),(0,r.kt)("p",null,"It essentially returns what's being queried for, e.g., author or category. If the current page is querying posts within a certain author, then that author object will be populated in ",(0,r.kt)("inlineCode",{parentName:"p"},"data.queriedObject.author"),". Similarly, if the current page is querying posts from a given category ",(0,r.kt)("inlineCode",{parentName:"p"},"data.queriedObject.term")," will be populated with that category."),(0,r.kt)("p",null,"Example: "),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},"// category-name can either come from the URL or be manually specified.\nconst { data } = usePosts({ taxonomy: 'category', category: 'cat-name' });\n\nreturn (\n

Category Page: {data.queriedObject.term.name}

\n);\n")),(0,r.kt)("h2",{id:"category-archive"},"Category Archive"),(0,r.kt)("p",null,"You can use the ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," hook to create a category archive route (",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/category/[...path].js"),")."),(0,r.kt)("admonition",{type:"info"},(0,r.kt)("p",{parentName:"admonition"},"We use ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," here because ",(0,r.kt)("strong",{parentName:"p"},"we do not want")," the ",(0,r.kt)("inlineCode",{parentName:"p"},"/category")," route to render anything.")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/category/[...path].js"',title:'"src/pages/category/[...path].js"'},"import {\n usePosts,\n fetchHookData,\n addHookData,\n handleError,\n} from '@headstartwp/next';\n\nconst CategoryPage = () => {\n const { data } = usePosts({ taxonomy: 'category' });\n\n return (\n <>\n

Category Page: {data.queriedObject.term.name}

\n
    \n {data.posts.map((post) => (\n
  • \n {post.title.rendered}\n
  • \n ))}\n
\n \n \n );\n};\n")),(0,r.kt)("h2",{id:"archive-path-matching"},"Archive Path Matching"),(0,r.kt)("p",null,"When using ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts"),' to create archive pages (e.g. a category archive) you can optionally enable "archive path matching" to ensure that your archive routes match the expected permalink dictated by WordPress. Without "archive path matching", your archive routes would match as long as the last segment of the url is a valid term slug. '),(0,r.kt)("p",null,"For instance, let's take the ",(0,r.kt)("inlineCode",{parentName:"p"},"/category/[...path].js")," route above. It will match URLs like:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"/category/cat-name"),(0,r.kt)("li",{parentName:"ul"},"/category/parent-cat-name/cat-name")),(0,r.kt)("p",null,"The framework, however, does not check if ",(0,r.kt)("inlineCode",{parentName:"p"},"parent-cat-name")," is the de facto parent of cat-name, and even worse, it has no way to know (without additional rest api calls) if ",(0,r.kt)("inlineCode",{parentName:"p"},"parent-cat-name")," is even a valid category."),(0,r.kt)("p",null,"To address this, you can pass ",(0,r.kt)("inlineCode",{parentName:"p"},"matchArchivePath")," to ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," to tell the framework to check the ",(0,r.kt)("inlineCode",{parentName:"p"},"link")," property of the ",(0,r.kt)("inlineCode",{parentName:"p"},"queriedObject"),", i.e if the ",(0,r.kt)("inlineCode",{parentName:"p"},"link")," property of ",(0,r.kt)("inlineCode",{parentName:"p"},"cat-name")," returned by the ",(0,r.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/rest-api/reference/categories/#schema"},"WordPress REST API")," matches the front-end path."),(0,r.kt)("p",null,"This setting can also be enabled in ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," globally."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n // enable archive path mapping for all default taxonomies\n customTaxonomies: (defaultTaxonomies) => {\n return defaultTaxonomies.map((taxonomy) => ({ ...taxonomy, matchArchivePath: true })),\n },\n}\n")),(0,r.kt)("h2",{id:"known-limitations"},"Known limitations"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"It is not possible to fetch posts from more than one post type.")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7742af19.02e0a7e5.js b/assets/js/7742af19.563b6b70.js similarity index 95% rename from assets/js/7742af19.02e0a7e5.js rename to assets/js/7742af19.563b6b70.js index 8525ff7ed..8a0d807aa 100644 --- a/assets/js/7742af19.02e0a7e5.js +++ b/assets/js/7742af19.563b6b70.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6494],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),c=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(o,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[s]="string"==typeof e?e:n,l[1]=p;for(var c=2;c{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.HeadingBlockProps",title:"Interface: HeadingBlockProps",sidebar_label:"@headstartwp/core.react.HeadingBlockProps",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.HeadingBlockProps",id:"interfaces/headstartwp_core.react.HeadingBlockProps",title:"Interface: HeadingBlockProps",description:"@headstartwp/core.react.HeadingBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.HeadingBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.HeadingBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.HeadingBlockProps",title:"Interface: HeadingBlockProps",sidebar_label:"@headstartwp/core.react.HeadingBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.GutenbergBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GutenbergBlockProps"},next:{title:"@headstartwp/core.react.HookResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.HookResponse"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"level",id:"level",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".HeadingBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"HeadingBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"level"},"level"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"level"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/HeadingBlock.tsx#L7"},"packages/core/src/react/blocks/HeadingBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6494],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),c=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(o,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[s]="string"==typeof e?e:n,l[1]=p;for(var c=2;c{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.HeadingBlockProps",title:"Interface: HeadingBlockProps",sidebar_label:"@headstartwp/core.react.HeadingBlockProps",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.HeadingBlockProps",id:"interfaces/headstartwp_core.react.HeadingBlockProps",title:"Interface: HeadingBlockProps",description:"@headstartwp/core.react.HeadingBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.HeadingBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.HeadingBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.HeadingBlockProps",title:"Interface: HeadingBlockProps",sidebar_label:"@headstartwp/core.react.HeadingBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.GutenbergBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GutenbergBlockProps"},next:{title:"@headstartwp/core.react.HookResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.HookResponse"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"level",id:"level",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".HeadingBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"HeadingBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"level"},"level"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"level"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/HeadingBlock.tsx#L7"},"packages/core/src/react/blocks/HeadingBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7844975a.721e56dd.js b/assets/js/7844975a.b09c5ed4.js similarity index 97% rename from assets/js/7844975a.721e56dd.js rename to assets/js/7844975a.b09c5ed4.js index ab5a26645..38253c7e7 100644 --- a/assets/js/7844975a.721e56dd.js +++ b/assets/js/7844975a.b09c5ed4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4762],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.IListBlock",title:"Interface: IListBlock",sidebar_label:"@headstartwp/core.react.IListBlock",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IListBlock",id:"interfaces/headstartwp_core.react.IListBlock",title:"Interface: IListBlock",description:"@headstartwp/core.react.IListBlock",source:"@site/docs/interfaces/headstartwp_core.react.IListBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IListBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IListBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IListBlock",title:"Interface: IListBlock",sidebar_label:"@headstartwp/core.react.IListBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IImageBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"},next:{title:"@headstartwp/core.react.IMediaTextBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IListBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ListBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IListBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ListBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ListBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4762],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.IListBlock",title:"Interface: IListBlock",sidebar_label:"@headstartwp/core.react.IListBlock",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IListBlock",id:"interfaces/headstartwp_core.react.IListBlock",title:"Interface: IListBlock",description:"@headstartwp/core.react.IListBlock",source:"@site/docs/interfaces/headstartwp_core.react.IListBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IListBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IListBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IListBlock",title:"Interface: IListBlock",sidebar_label:"@headstartwp/core.react.IListBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IImageBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"},next:{title:"@headstartwp/core.react.IMediaTextBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IListBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ListBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IListBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ListBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ListBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7d0dd658.745c010b.js b/assets/js/7d0dd658.1d885545.js similarity index 90% rename from assets/js/7d0dd658.745c010b.js rename to assets/js/7d0dd658.1d885545.js index c5e3c2630..524547b43 100644 --- a/assets/js/7d0dd658.745c010b.js +++ b/assets/js/7d0dd658.1d885545.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7246],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>f});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function o(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var s=n.createContext({}),l=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},d=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),c=l(a),u=r,f=c["".concat(s,".").concat(u)]||c[u]||h[u]||i;return a?n.createElement(f,o(o({ref:t},d),{},{components:a})):n.createElement(f,o({ref:t},d))}));function f(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,o=new Array(i);o[0]=u;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[c]="string"==typeof e?e:r,o[1]=p;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>c,frontMatter:()=>i,metadata:()=>p,toc:()=>l});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.TaxonomyEntity",title:"Interface: TaxonomyEntity",sidebar_label:"@headstartwp/core.TaxonomyEntity",custom_edit_url:null},o=void 0,p={unversionedId:"interfaces/headstartwp_core.TaxonomyEntity",id:"interfaces/headstartwp_core.TaxonomyEntity",title:"Interface: TaxonomyEntity",description:"@headstartwp/core.TaxonomyEntity",source:"@site/docs/interfaces/headstartwp_core.TaxonomyEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.TaxonomyEntity",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.TaxonomyEntity",title:"Interface: TaxonomyEntity",sidebar_label:"@headstartwp/core.TaxonomyEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.TaxonomyArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},next:{title:"@headstartwp/core.TermEntity",permalink:"/docs/api/interfaces/headstartwp_core.TermEntity"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"hierarchical",id:"hierarchical",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"rest_base",id:"rest_base",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"types",id:"types",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:l};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".TaxonomyEntity"),(0,r.kt)("p",null,"Interface for entities from the /wp/v2/taxonomy endpoint."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"TaxonomyEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"A human-readable description of the taxonomy."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L397"},"packages/core/src/data/types/entities.ts:397")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hierarchical"},"hierarchical"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"hierarchical"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Whether or not the taxonomy should have children."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L402"},"packages/core/src/data/types/entities.ts:402")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The title for the taxonomy."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L407"},"packages/core/src/data/types/entities.ts:407")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"rest_base"},"rest","_","base"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"rest","_","base"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"REST base route for the taxonomy."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L417"},"packages/core/src/data/types/entities.ts:417")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"An alphanumeric identifier for the taxonomy."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L412"},"packages/core/src/data/types/entities.ts:412")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"types"},"types"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"types"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Types associated with the taxonomy."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L422"},"packages/core/src/data/types/entities.ts:422")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7246],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>m});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function o(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var s=n.createContext({}),l=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},d=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),c=l(a),u=r,m=c["".concat(s,".").concat(u)]||c[u]||h[u]||i;return a?n.createElement(m,o(o({ref:t},d),{},{components:a})):n.createElement(m,o({ref:t},d))}));function m(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,o=new Array(i);o[0]=u;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[c]="string"==typeof e?e:r,o[1]=p;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>c,frontMatter:()=>i,metadata:()=>p,toc:()=>l});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.TaxonomyEntity",title:"Interface: TaxonomyEntity",sidebar_label:"@headstartwp/core.TaxonomyEntity",custom_edit_url:null},o=void 0,p={unversionedId:"interfaces/headstartwp_core.TaxonomyEntity",id:"interfaces/headstartwp_core.TaxonomyEntity",title:"Interface: TaxonomyEntity",description:"@headstartwp/core.TaxonomyEntity",source:"@site/docs/interfaces/headstartwp_core.TaxonomyEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.TaxonomyEntity",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.TaxonomyEntity",title:"Interface: TaxonomyEntity",sidebar_label:"@headstartwp/core.TaxonomyEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.TaxonomyArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},next:{title:"@headstartwp/core.TermEntity",permalink:"/docs/api/interfaces/headstartwp_core.TermEntity"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"hierarchical",id:"hierarchical",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"rest_base",id:"rest_base",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"types",id:"types",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:l};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".TaxonomyEntity"),(0,r.kt)("p",null,"Interface for entities from the /wp/v2/taxonomy endpoint."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"TaxonomyEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"A human-readable description of the taxonomy."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L397"},"packages/core/src/data/types/entities.ts:397")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hierarchical"},"hierarchical"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"hierarchical"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Whether or not the taxonomy should have children."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L402"},"packages/core/src/data/types/entities.ts:402")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The title for the taxonomy."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L407"},"packages/core/src/data/types/entities.ts:407")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"rest_base"},"rest","_","base"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"rest","_","base"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"REST base route for the taxonomy."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L417"},"packages/core/src/data/types/entities.ts:417")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"An alphanumeric identifier for the taxonomy."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L412"},"packages/core/src/data/types/entities.ts:412")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"types"},"types"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"types"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Types associated with the taxonomy."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L422"},"packages/core/src/data/types/entities.ts:422")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7d4fdb35.a425ddea.js b/assets/js/7d4fdb35.faed2d7f.js similarity index 90% rename from assets/js/7d4fdb35.a425ddea.js rename to assets/js/7d4fdb35.faed2d7f.js index 1cd7fa8c9..bb39f7d9d 100644 --- a/assets/js/7d4fdb35.a425ddea.js +++ b/assets/js/7d4fdb35.faed2d7f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8109],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},s=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),d=c(r),m=n,h=d["".concat(p,".").concat(m)]||d[m]||k[m]||i;return r?a.createElement(h,o(o({ref:t},s),{},{components:r})):a.createElement(h,o({ref:t},s))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[d]="string"==typeof e?e:n,o[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.QuoteBlockProps",title:"Interface: QuoteBlockProps",sidebar_label:"@headstartwp/core.react.QuoteBlockProps",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.QuoteBlockProps",id:"interfaces/headstartwp_core.react.QuoteBlockProps",title:"Interface: QuoteBlockProps",description:"@headstartwp/core.react.QuoteBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.QuoteBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.QuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.QuoteBlockProps",title:"Interface: QuoteBlockProps",sidebar_label:"@headstartwp/core.react.QuoteBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.PullQuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},next:{title:"@headstartwp/core.react.SafeHtmlProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".QuoteBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"QuoteBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8109],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,o(o({ref:t},d),{},{components:r})):a.createElement(h,o({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[s]="string"==typeof e?e:n,o[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.QuoteBlockProps",title:"Interface: QuoteBlockProps",sidebar_label:"@headstartwp/core.react.QuoteBlockProps",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.QuoteBlockProps",id:"interfaces/headstartwp_core.react.QuoteBlockProps",title:"Interface: QuoteBlockProps",description:"@headstartwp/core.react.QuoteBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.QuoteBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.QuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.QuoteBlockProps",title:"Interface: QuoteBlockProps",sidebar_label:"@headstartwp/core.react.QuoteBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.PullQuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},next:{title:"@headstartwp/core.react.SafeHtmlProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".QuoteBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"QuoteBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/8062ea35.83254880.js b/assets/js/8062ea35.fbdcd301.js similarity index 98% rename from assets/js/8062ea35.83254880.js rename to assets/js/8062ea35.fbdcd301.js index 36ff2f5e9..960eb6318 100644 --- a/assets/js/8062ea35.83254880.js +++ b/assets/js/8062ea35.fbdcd301.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7253],{3905:(e,t,n)=>{n.d(t,{Zo:()=>k,kt:()=>u});var r=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var o=r.createContext({}),p=function(e){var t=r.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},k=function(e){var t=p(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,o=e.parentName,k=d(e,["components","mdxType","originalType","parentName"]),s=p(n),m=i,u=s["".concat(o,".").concat(m)]||s[m]||c[m]||a;return n?r.createElement(u,l(l({ref:t},k),{},{components:n})):r.createElement(u,l({ref:t},k))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=m;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d[s]="string"==typeof e?e:i,l[1]=d;for(var p=2;p{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>a,metadata:()=>d,toc:()=>p});var r=n(7462),i=(n(7294),n(3905));const a={id:"headstartwp_next.LinkBlockProps",title:"Interface: LinkBlockProps",sidebar_label:"@headstartwp/next.LinkBlockProps",custom_edit_url:null},l=void 0,d={unversionedId:"interfaces/headstartwp_next.LinkBlockProps",id:"interfaces/headstartwp_next.LinkBlockProps",title:"Interface: LinkBlockProps",description:"@headstartwp/next.LinkBlockProps",source:"@site/docs/interfaces/headstartwp_next.LinkBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_next.LinkBlockProps",permalink:"/docs/api/interfaces/headstartwp_next.LinkBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_next.LinkBlockProps",title:"Interface: LinkBlockProps",sidebar_label:"@headstartwp/next.LinkBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/next.ImageProps",permalink:"/docs/api/interfaces/headstartwp_next.ImageProps"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"href",id:"href",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"rel",id:"rel",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4}],k={toc:p};function s(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},k,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next"},"@headstartwp/next"),".LinkBlockProps"),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("inlineCode",{parentName:"p"},"IBlockAttributes")),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"LinkBlockProps"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"attributes"},"attributes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"attributes"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"align")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Align"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"border")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Border"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"colors")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Colors"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"spacing")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Spacing"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"typography")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Typography"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"width?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.attributes"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:70"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"children"},"children"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"children"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.children"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:69"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"classname"},"className"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"className"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.className"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:65"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"domnode"},"domNode"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"domNode"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Element")),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.domNode"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:67"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"href"},"href"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"href"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/blocks/LinkBlock.tsx#L7"},"packages/next/src/blocks/LinkBlock.tsx:7")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.htmlAnchor"),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:68"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"name"},"name"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"name"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.name"),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:64"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"rel"},"rel"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"rel"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/blocks/LinkBlock.tsx#L8"},"packages/next/src/blocks/LinkBlock.tsx:8")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"style"},"style"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"style"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.style"),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:66"))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7253],{3905:(e,t,n)=>{n.d(t,{Zo:()=>k,kt:()=>u});var r=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var o=r.createContext({}),p=function(e){var t=r.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},k=function(e){var t=p(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,o=e.parentName,k=d(e,["components","mdxType","originalType","parentName"]),s=p(n),m=i,u=s["".concat(o,".").concat(m)]||s[m]||c[m]||a;return n?r.createElement(u,l(l({ref:t},k),{},{components:n})):r.createElement(u,l({ref:t},k))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=m;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d[s]="string"==typeof e?e:i,l[1]=d;for(var p=2;p{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>a,metadata:()=>d,toc:()=>p});var r=n(7462),i=(n(7294),n(3905));const a={id:"headstartwp_next.LinkBlockProps",title:"Interface: LinkBlockProps",sidebar_label:"@headstartwp/next.LinkBlockProps",custom_edit_url:null},l=void 0,d={unversionedId:"interfaces/headstartwp_next.LinkBlockProps",id:"interfaces/headstartwp_next.LinkBlockProps",title:"Interface: LinkBlockProps",description:"@headstartwp/next.LinkBlockProps",source:"@site/docs/interfaces/headstartwp_next.LinkBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_next.LinkBlockProps",permalink:"/docs/api/interfaces/headstartwp_next.LinkBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_next.LinkBlockProps",title:"Interface: LinkBlockProps",sidebar_label:"@headstartwp/next.LinkBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/next.ImageProps",permalink:"/docs/api/interfaces/headstartwp_next.ImageProps"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"href",id:"href",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"rel",id:"rel",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4}],k={toc:p};function s(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},k,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next"},"@headstartwp/next"),".LinkBlockProps"),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("inlineCode",{parentName:"p"},"IBlockAttributes")),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"LinkBlockProps"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"attributes"},"attributes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"attributes"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"align")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Align"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"border")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Border"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"colors")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Colors"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"spacing")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Spacing"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"typography")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Typography"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"width?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.attributes"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:70"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"children"},"children"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"children"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.children"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:69"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"classname"},"className"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"className"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.className"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:65"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"domnode"},"domNode"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"domNode"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Element")),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.domNode"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:67"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"href"},"href"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"href"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/blocks/LinkBlock.tsx#L7"},"packages/next/src/blocks/LinkBlock.tsx:7")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.htmlAnchor"),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:68"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"name"},"name"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"name"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.name"),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:64"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"rel"},"rel"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"rel"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/blocks/LinkBlock.tsx#L8"},"packages/next/src/blocks/LinkBlock.tsx:8")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"style"},"style"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"style"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.style"),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:66"))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/82691c56.45e75f7e.js b/assets/js/82691c56.55d18aa9.js similarity index 99% rename from assets/js/82691c56.45e75f7e.js rename to assets/js/82691c56.55d18aa9.js index 4e0d42117..96748b768 100644 --- a/assets/js/82691c56.45e75f7e.js +++ b/assets/js/82691c56.55d18aa9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3641],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=a.createContext({}),c=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},p=function(e){var t=c(e.components);return a.createElement(l.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=c(n),h=r,m=u["".concat(l,".").concat(h)]||u[h]||d[h]||o;return n?a.createElement(m,i(i({ref:t},p),{},{components:n})):a.createElement(m,i({ref:t},p))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,i=new Array(o);i[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[u]="string"==typeof e?e:r,i[1]=s;for(var c=2;c{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>c});var a=n(7462),r=(n(7294),n(3905));const o={slug:"/data-fetching",sidebar_label:"Introduction",sidebar_position:0},i="Introduction",s={unversionedId:"Data Fetching/introduction",id:"Data Fetching/introduction",title:"Introduction",description:'HeadstartWP exposes several customs react hooks that provide a seamless data-fetching experience with WordPress. Those hooks are built to be "isomorphic" i.e can be executed either on the browser or on the server (e.g: Node.js).',source:"@site/documentation/02 - Data Fetching/introduction.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching",permalink:"/docs/learn/data-fetching",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/introduction.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:0,frontMatter:{slug:"/data-fetching",sidebar_label:"Introduction",sidebar_position:0},sidebar:"tutorialSidebar",previous:{title:"Quick Introduction to the Framework",permalink:"/docs/learn/getting-started/quick-tutorial"},next:{title:"The usePost hook",permalink:"/docs/learn/data-fetching/usepost"}},l={},c=[{value:"React Custom hooks",id:"react-custom-hooks",level:2},{value:"Next.js "bindings"",id:"nextjs-bindings",level:2}],p={toc:c};function u(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"introduction"},"Introduction"),(0,r.kt)("p",null,'HeadstartWP exposes several customs react hooks that provide a seamless data-fetching experience with WordPress. Those hooks are built to be "isomorphic" i.e can be executed either on the browser or on the server (e.g: Node.js).'),(0,r.kt)("p",null,"The data-fetching logic itself is abstracted by ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/headstartwp_core.AbstractFetchStrategy/"},"strategies"),". The custom React hooks are powered by ",(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app/"},"useSwr"),"."),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"With Next.js ",(0,r.kt)("inlineCode",{parentName:"p"},"app")," directory support added in Next.js 13, we will be providing special hooks that will work well with Suspense and Streaming. At the moment, we do not recommend using the existing custom hooks in the ",(0,r.kt)("inlineCode",{parentName:"p"},"app")," directory.")),(0,r.kt)("h2",{id:"react-custom-hooks"},"React Custom hooks"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/core/react")," package export exposes the react hooks implementation on top of the ",(0,r.kt)("inlineCode",{parentName:"p"},"useSwr")," library. Those hooks are called ",(0,r.kt)("inlineCode",{parentName:"p"},"useFetch*")," e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"useFetchPost"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"useFetchPosts")," and so on. They can be used outside of Next.js (i.e create-react-app, React Native etc.)."),(0,r.kt)("h2",{id:"nextjs-bindings"},'Next.js "bindings"'),(0,r.kt)("p",null,"Next.js is the main meta-framework supported by HeadstartWP, therefore we provide special bindings that make using the framework a breeze."),(0,r.kt)("p",null,"The Next.js bindings are exposed by the ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/next")," package."),(0,r.kt)("p",null,'The main difference is that the Next.js binding will automatically extract URL segments into request params (i.e extracting post name from the URL automatically) when used in conjunction with the "path" catch-all pattern like ',(0,r.kt)("inlineCode",{parentName:"p"},"src/page/[...path.js]"),"."),(0,r.kt)("p",null,"The following example uses the ",(0,r.kt)("inlineCode",{parentName:"p"},"useFetchPost")," to manually fetch a page with the ",(0,r.kt)("inlineCode",{parentName:"p"},"about")," slug."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"import { useFetchPost } from '@headstartwp/core/react';\n\nconst Page = () => {\n const { data: { post }, loading } = useFetchPost({ slug: 'about', post_type: 'page' });\n\n if (loading) {\n return 'Loading...';\n }\n\n return (

{post.title.rendered}

);\n};\n")),(0,r.kt)("p",null,"You could omit the ",(0,r.kt)("inlineCode",{parentName:"p"},"slug")," param by specifying the current path of the page and it will parse the path and extract matched params following the WordPress pretty permalinks convention."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"usePost({ post_type: 'page' }, {}, '/about');\n")),(0,r.kt)("p",null,"By using the Next.js bindings and following the path catch-all route convention, the URL extraction is automatic."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"import { usePost } from '@headstartwp/next';\n\nconst Page = () => {\n // slug is automatically injected from the next.js router\n // if you pass a slug it will override what's coming from the URL\n const { loading, error, data } = usePost({ post_type: 'page' });\n\n if (loading) {\n return 'Loading...';\n }\n\n\n return (

{post.title.rendered}

);\n};\n")),(0,r.kt)("p",null,"Then visiting a URL like ",(0,r.kt)("inlineCode",{parentName:"p"},"/about")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"/privacy-policy")," will render the contents of the about and privacy policy pages respectively."),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},'The remaining of this section will assume the Next.js versions of the hooks are used. It will also assume the "path" catch-all route conventions are being used.')))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3641],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=a.createContext({}),c=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},p=function(e){var t=c(e.components);return a.createElement(l.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=c(n),h=r,m=u["".concat(l,".").concat(h)]||u[h]||d[h]||o;return n?a.createElement(m,i(i({ref:t},p),{},{components:n})):a.createElement(m,i({ref:t},p))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,i=new Array(o);i[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[u]="string"==typeof e?e:r,i[1]=s;for(var c=2;c{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>c});var a=n(7462),r=(n(7294),n(3905));const o={slug:"/data-fetching",sidebar_label:"Introduction",sidebar_position:0},i="Introduction",s={unversionedId:"Data Fetching/introduction",id:"Data Fetching/introduction",title:"Introduction",description:'HeadstartWP exposes several customs react hooks that provide a seamless data-fetching experience with WordPress. Those hooks are built to be "isomorphic" i.e can be executed either on the browser or on the server (e.g: Node.js).',source:"@site/documentation/02 - Data Fetching/introduction.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching",permalink:"/docs/learn/data-fetching",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/introduction.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:0,frontMatter:{slug:"/data-fetching",sidebar_label:"Introduction",sidebar_position:0},sidebar:"tutorialSidebar",previous:{title:"Quick Introduction to the Framework",permalink:"/docs/learn/getting-started/quick-tutorial"},next:{title:"The usePost hook",permalink:"/docs/learn/data-fetching/usepost"}},l={},c=[{value:"React Custom hooks",id:"react-custom-hooks",level:2},{value:"Next.js "bindings"",id:"nextjs-bindings",level:2}],p={toc:c};function u(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"introduction"},"Introduction"),(0,r.kt)("p",null,'HeadstartWP exposes several customs react hooks that provide a seamless data-fetching experience with WordPress. Those hooks are built to be "isomorphic" i.e can be executed either on the browser or on the server (e.g: Node.js).'),(0,r.kt)("p",null,"The data-fetching logic itself is abstracted by ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/headstartwp_core.AbstractFetchStrategy/"},"strategies"),". The custom React hooks are powered by ",(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app/"},"useSwr"),"."),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"With Next.js ",(0,r.kt)("inlineCode",{parentName:"p"},"app")," directory support added in Next.js 13, we will be providing special hooks that will work well with Suspense and Streaming. At the moment, we do not recommend using the existing custom hooks in the ",(0,r.kt)("inlineCode",{parentName:"p"},"app")," directory.")),(0,r.kt)("h2",{id:"react-custom-hooks"},"React Custom hooks"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/core/react")," package export exposes the react hooks implementation on top of the ",(0,r.kt)("inlineCode",{parentName:"p"},"useSwr")," library. Those hooks are called ",(0,r.kt)("inlineCode",{parentName:"p"},"useFetch*")," e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"useFetchPost"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"useFetchPosts")," and so on. They can be used outside of Next.js (i.e create-react-app, React Native etc.)."),(0,r.kt)("h2",{id:"nextjs-bindings"},'Next.js "bindings"'),(0,r.kt)("p",null,"Next.js is the main meta-framework supported by HeadstartWP, therefore we provide special bindings that make using the framework a breeze."),(0,r.kt)("p",null,"The Next.js bindings are exposed by the ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/next")," package."),(0,r.kt)("p",null,'The main difference is that the Next.js binding will automatically extract URL segments into request params (i.e extracting post name from the URL automatically) when used in conjunction with the "path" catch-all pattern like ',(0,r.kt)("inlineCode",{parentName:"p"},"src/page/[...path.js]"),"."),(0,r.kt)("p",null,"The following example uses the ",(0,r.kt)("inlineCode",{parentName:"p"},"useFetchPost")," to manually fetch a page with the ",(0,r.kt)("inlineCode",{parentName:"p"},"about")," slug."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"import { useFetchPost } from '@headstartwp/core/react';\n\nconst Page = () => {\n const { data: { post }, loading } = useFetchPost({ slug: 'about', post_type: 'page' });\n\n if (loading) {\n return 'Loading...';\n }\n\n return (

{post.title.rendered}

);\n};\n")),(0,r.kt)("p",null,"You could omit the ",(0,r.kt)("inlineCode",{parentName:"p"},"slug")," param by specifying the current path of the page and it will parse the path and extract matched params following the WordPress pretty permalinks convention."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"usePost({ post_type: 'page' }, {}, '/about');\n")),(0,r.kt)("p",null,"By using the Next.js bindings and following the path catch-all route convention, the URL extraction is automatic."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"import { usePost } from '@headstartwp/next';\n\nconst Page = () => {\n // slug is automatically injected from the next.js router\n // if you pass a slug it will override what's coming from the URL\n const { loading, error, data } = usePost({ post_type: 'page' });\n\n if (loading) {\n return 'Loading...';\n }\n\n\n return (

{post.title.rendered}

);\n};\n")),(0,r.kt)("p",null,"Then visiting a URL like ",(0,r.kt)("inlineCode",{parentName:"p"},"/about")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"/privacy-policy")," will render the contents of the about and privacy policy pages respectively."),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},'The remaining of this section will assume the Next.js versions of the hooks are used. It will also assume the "path" catch-all route conventions are being used.')))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/829b8700.fc69fa8a.js b/assets/js/829b8700.e48e1ef5.js similarity index 97% rename from assets/js/829b8700.fc69fa8a.js rename to assets/js/829b8700.e48e1ef5.js index c33780a3c..bc255da43 100644 --- a/assets/js/829b8700.fc69fa8a.js +++ b/assets/js/829b8700.e48e1ef5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2570],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.ICoverBlock",title:"Interface: ICoverBlock",sidebar_label:"@headstartwp/core.react.ICoverBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.ICoverBlock",id:"interfaces/headstartwp_core.react.ICoverBlock",title:"Interface: ICoverBlock",description:"@headstartwp/core.react.ICoverBlock",source:"@site/docs/interfaces/headstartwp_core.react.ICoverBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ICoverBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ICoverBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ICoverBlock",title:"Interface: ICoverBlock",sidebar_label:"@headstartwp/core.react.ICoverBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IColumnsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock"},next:{title:"@headstartwp/core.react.IDataWPBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IDataWPBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ICoverBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CoverBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ICoverBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CoverBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CoverBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2570],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.ICoverBlock",title:"Interface: ICoverBlock",sidebar_label:"@headstartwp/core.react.ICoverBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.ICoverBlock",id:"interfaces/headstartwp_core.react.ICoverBlock",title:"Interface: ICoverBlock",description:"@headstartwp/core.react.ICoverBlock",source:"@site/docs/interfaces/headstartwp_core.react.ICoverBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ICoverBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ICoverBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ICoverBlock",title:"Interface: ICoverBlock",sidebar_label:"@headstartwp/core.react.ICoverBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IColumnsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock"},next:{title:"@headstartwp/core.react.IDataWPBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IDataWPBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ICoverBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CoverBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ICoverBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CoverBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CoverBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/84bf0742.4c5b3e65.js b/assets/js/84bf0742.35e23cfb.js similarity index 97% rename from assets/js/84bf0742.4c5b3e65.js rename to assets/js/84bf0742.35e23cfb.js index 14a1d0290..029d7d532 100644 --- a/assets/js/84bf0742.4c5b3e65.js +++ b/assets/js/84bf0742.35e23cfb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5145],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>u});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function l(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),s=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},c=function(e){var t=s(e.components);return n.createElement(p.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,l=e.originalType,p=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),d=s(r),m=a,u=d["".concat(p,".").concat(m)]||d[m]||k[m]||l;return r?n.createElement(u,o(o({ref:t},c),{},{components:r})):n.createElement(u,o({ref:t},c))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=r.length,o=new Array(l);o[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[d]="string"==typeof e?e:a,o[1]=i;for(var s=2;s{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>d,frontMatter:()=>l,metadata:()=>i,toc:()=>s});var n=r(7462),a=(r(7294),r(3905));const l={id:"headstartwp_core.react.BlockRendererProps",title:"Interface: BlockRendererProps",sidebar_label:"@headstartwp/core.react.BlockRendererProps",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.BlockRendererProps",id:"interfaces/headstartwp_core.react.BlockRendererProps",title:"Interface: BlockRendererProps",description:"@headstartwp/core.react.BlockRendererProps",source:"@site/docs/interfaces/headstartwp_core.react.BlockRendererProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.BlockRendererProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockRendererProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.BlockRendererProps",title:"Interface: BlockRendererProps",sidebar_label:"@headstartwp/core.react.BlockRendererProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.BlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},next:{title:"@headstartwp/core.react.ButtonBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"}},p={},s=[{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"html",id:"html",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"ksesAllowList",id:"ksesallowlist",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"sanitizeFn",id:"sanitizefn",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:s};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".BlockRendererProps"),(0,a.kt)("p",null,"The type definition for the ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," component."),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"children"},"children"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"children"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,a.kt)("p",null,"The children components that must implements ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},"BlockProps"),". Failing to implement ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},"BlockProps"),"\nwill issue a warning at runtime."),(0,a.kt)("p",null,"Passing children are not mandatory, if you do not pass them ",(0,a.kt)("inlineCode",{parentName:"p"},"BlocksRenderer")," will simply sanitize the html markup."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L110"},"packages/core/src/react/components/BlocksRenderer.tsx:110")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"html"},"html"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"html"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The HTML string to be parsed."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},',\n')),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L83"},"packages/core/src/react/components/BlocksRenderer.tsx:83")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ksesallowlist"},"ksesAllowList"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"ksesAllowList"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"IWhiteList")),(0,a.kt)("p",null,"The allow list for the parser"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},',\n')),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L95"},"packages/core/src/react/components/BlocksRenderer.tsx:95")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"sanitizefn"},"sanitizeFn"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"sanitizeFn"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"html"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"ksesAllowList?"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"IWhiteList"),") => ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"html"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"ksesAllowList?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"A custom implementation of the sanitize function."),(0,a.kt)("p",null,"If none is provided it's going to default to ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#wpksespost"},"wpKsesPost")),(0,a.kt)("h5",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"html")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"ksesAllowList?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"IWhiteList"))))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L102"},"packages/core/src/react/components/BlocksRenderer.tsx:102")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5145],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>u});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function l(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),s=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},c=function(e){var t=s(e.components);return n.createElement(p.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,l=e.originalType,p=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),d=s(r),m=a,u=d["".concat(p,".").concat(m)]||d[m]||k[m]||l;return r?n.createElement(u,o(o({ref:t},c),{},{components:r})):n.createElement(u,o({ref:t},c))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=r.length,o=new Array(l);o[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[d]="string"==typeof e?e:a,o[1]=i;for(var s=2;s{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>d,frontMatter:()=>l,metadata:()=>i,toc:()=>s});var n=r(7462),a=(r(7294),r(3905));const l={id:"headstartwp_core.react.BlockRendererProps",title:"Interface: BlockRendererProps",sidebar_label:"@headstartwp/core.react.BlockRendererProps",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.BlockRendererProps",id:"interfaces/headstartwp_core.react.BlockRendererProps",title:"Interface: BlockRendererProps",description:"@headstartwp/core.react.BlockRendererProps",source:"@site/docs/interfaces/headstartwp_core.react.BlockRendererProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.BlockRendererProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockRendererProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.BlockRendererProps",title:"Interface: BlockRendererProps",sidebar_label:"@headstartwp/core.react.BlockRendererProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.BlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},next:{title:"@headstartwp/core.react.ButtonBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"}},p={},s=[{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"html",id:"html",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"ksesAllowList",id:"ksesallowlist",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"sanitizeFn",id:"sanitizefn",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:s};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".BlockRendererProps"),(0,a.kt)("p",null,"The type definition for the ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," component."),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"children"},"children"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"children"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,a.kt)("p",null,"The children components that must implements ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},"BlockProps"),". Failing to implement ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},"BlockProps"),"\nwill issue a warning at runtime."),(0,a.kt)("p",null,"Passing children are not mandatory, if you do not pass them ",(0,a.kt)("inlineCode",{parentName:"p"},"BlocksRenderer")," will simply sanitize the html markup."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L110"},"packages/core/src/react/components/BlocksRenderer.tsx:110")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"html"},"html"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"html"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The HTML string to be parsed."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},',\n')),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L83"},"packages/core/src/react/components/BlocksRenderer.tsx:83")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ksesallowlist"},"ksesAllowList"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"ksesAllowList"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"IWhiteList")),(0,a.kt)("p",null,"The allow list for the parser"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},',\n')),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L95"},"packages/core/src/react/components/BlocksRenderer.tsx:95")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"sanitizefn"},"sanitizeFn"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"sanitizeFn"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"html"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"ksesAllowList?"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"IWhiteList"),") => ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"html"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"ksesAllowList?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"A custom implementation of the sanitize function."),(0,a.kt)("p",null,"If none is provided it's going to default to ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#wpksespost"},"wpKsesPost")),(0,a.kt)("h5",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"html")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"ksesAllowList?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"IWhiteList"))))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L102"},"packages/core/src/react/components/BlocksRenderer.tsx:102")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/8872dee1.2574078c.js b/assets/js/8872dee1.cadc41e6.js similarity index 98% rename from assets/js/8872dee1.2574078c.js rename to assets/js/8872dee1.cadc41e6.js index e75937c5f..6d49c3214 100644 --- a/assets/js/8872dee1.2574078c.js +++ b/assets/js/8872dee1.cadc41e6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9638],{3905:(e,t,n)=>{n.d(t,{Zo:()=>l,kt:()=>f});var r=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var c=r.createContext({}),u=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},l=function(e){var t=u(e.components);return r.createElement(c.Provider,{value:t},e.children)},p="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,a=e.originalType,c=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),p=u(n),h=o,f=p["".concat(c,".").concat(h)]||p[h]||d[h]||a;return n?r.createElement(f,i(i({ref:t},l),{},{components:n})):r.createElement(f,i({ref:t},l))}));function f(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=n.length,i=new Array(a);i[0]=h;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s[p]="string"==typeof e?e:o,i[1]=s;for(var u=2;u{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>p,frontMatter:()=>a,metadata:()=>s,toc:()=>u});var r=n(7462),o=(n(7294),n(3905));const a={slug:"/data-fetching/useSeo",sidebar_position:7},i="The useSeo hook",s={unversionedId:"Data Fetching/useSeo",id:"Data Fetching/useSeo",title:"The useSeo hook",description:"This hook was introduced in @headstartwp/next@1.1.0",source:"@site/documentation/02 - Data Fetching/useSeo.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/useSeo",permalink:"/docs/learn/data-fetching/useSeo",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/useSeo.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:7,frontMatter:{slug:"/data-fetching/useSeo",sidebar_position:7},sidebar:"tutorialSidebar",previous:{title:"The useSearch hook",permalink:"/docs/learn/data-fetching/usesearch"},next:{title:"Creating your own custom hooks",permalink:"/docs/learn/data-fetching/creating-your-own-custom-hooks"}},c={},u=[{value:"Basic Usage",id:"basic-usage",level:2}],l={toc:u};function p(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"the-useseo-hook"},"The useSeo hook"),(0,o.kt)("admonition",{type:"info"},(0,o.kt)("p",{parentName:"admonition"},"This hook was introduced in ",(0,o.kt)("inlineCode",{parentName:"p"},"@headstartwp/next@1.1.0"))),(0,o.kt)("p",null,"The ",(0,o.kt)("inlineCode",{parentName:"p"},"useSeo")," hook returns the SEO data for the current page."),(0,o.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-javascript"},"// by default it returns the json object\nconst yoast_json = useSeo();\nconst yoast_json = useSeo('json');\n// but you can also get the plain html markup for the metadata\nconst yoast_head = useSeo('html');\n")),(0,o.kt)("p",null,"If there's no seo information for the current route, this hook will return ",(0,o.kt)("inlineCode",{parentName:"p"},"null")," therefore we recommend checking for null before using the return value."))}p.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9638],{3905:(e,t,n)=>{n.d(t,{Zo:()=>l,kt:()=>f});var r=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var c=r.createContext({}),u=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},l=function(e){var t=u(e.components);return r.createElement(c.Provider,{value:t},e.children)},p="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,a=e.originalType,c=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),p=u(n),h=o,f=p["".concat(c,".").concat(h)]||p[h]||d[h]||a;return n?r.createElement(f,i(i({ref:t},l),{},{components:n})):r.createElement(f,i({ref:t},l))}));function f(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=n.length,i=new Array(a);i[0]=h;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s[p]="string"==typeof e?e:o,i[1]=s;for(var u=2;u{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>p,frontMatter:()=>a,metadata:()=>s,toc:()=>u});var r=n(7462),o=(n(7294),n(3905));const a={slug:"/data-fetching/useSeo",sidebar_position:7},i="The useSeo hook",s={unversionedId:"Data Fetching/useSeo",id:"Data Fetching/useSeo",title:"The useSeo hook",description:"This hook was introduced in @headstartwp/next@1.1.0",source:"@site/documentation/02 - Data Fetching/useSeo.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/useSeo",permalink:"/docs/learn/data-fetching/useSeo",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/useSeo.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:7,frontMatter:{slug:"/data-fetching/useSeo",sidebar_position:7},sidebar:"tutorialSidebar",previous:{title:"The useSearch hook",permalink:"/docs/learn/data-fetching/usesearch"},next:{title:"Creating your own custom hooks",permalink:"/docs/learn/data-fetching/creating-your-own-custom-hooks"}},c={},u=[{value:"Basic Usage",id:"basic-usage",level:2}],l={toc:u};function p(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"the-useseo-hook"},"The useSeo hook"),(0,o.kt)("admonition",{type:"info"},(0,o.kt)("p",{parentName:"admonition"},"This hook was introduced in ",(0,o.kt)("inlineCode",{parentName:"p"},"@headstartwp/next@1.1.0"))),(0,o.kt)("p",null,"The ",(0,o.kt)("inlineCode",{parentName:"p"},"useSeo")," hook returns the SEO data for the current page."),(0,o.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-javascript"},"// by default it returns the json object\nconst yoast_json = useSeo();\nconst yoast_json = useSeo('json');\n// but you can also get the plain html markup for the metadata\nconst yoast_head = useSeo('html');\n")),(0,o.kt)("p",null,"If there's no seo information for the current route, this hook will return ",(0,o.kt)("inlineCode",{parentName:"p"},"null")," therefore we recommend checking for null before using the return value."))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/88a75f53.f6e2d1b2.js b/assets/js/88a75f53.72952a9b.js similarity index 94% rename from assets/js/88a75f53.f6e2d1b2.js rename to assets/js/88a75f53.72952a9b.js index 746eb825c..0c773d168 100644 --- a/assets/js/88a75f53.f6e2d1b2.js +++ b/assets/js/88a75f53.72952a9b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1272],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var l=n.createContext({}),d=function(e){var t=n.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return n.createElement(l.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,l=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),c=d(a),h=r,k=c["".concat(l,".").concat(h)]||c[h]||u[h]||i;return a?n.createElement(k,p(p({ref:t},o),{},{components:a})):n.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[c]="string"==typeof e?e:r,p[1]=s;for(var d=2;d{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.AuthorEntity",title:"Interface: AuthorEntity",sidebar_label:"@headstartwp/core.AuthorEntity",custom_edit_url:null},p=void 0,s={unversionedId:"interfaces/headstartwp_core.AuthorEntity",id:"interfaces/headstartwp_core.AuthorEntity",title:"Interface: AuthorEntity",description:"@headstartwp/core.AuthorEntity",source:"@site/docs/interfaces/headstartwp_core.AuthorEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.AuthorEntity",permalink:"/docs/api/interfaces/headstartwp_core.AuthorEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AuthorEntity",title:"Interface: AuthorEntity",sidebar_label:"@headstartwp/core.AuthorEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AttachmentEntity",permalink:"/docs/api/interfaces/headstartwp_core.AttachmentEntity"},next:{title:"@headstartwp/core.AvatarUrls",permalink:"/docs/api/interfaces/headstartwp_core.AvatarUrls"}},l={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"avatar_urls",id:"avatar_urls",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"link",id:"link",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-9",level:4}],o={toc:d};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AuthorEntity"),(0,r.kt)("p",null,"Interface for entities from the /wp/v2/users endpoint."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"AuthorEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"avatar_urls"},"avatar","_","urls"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"avatar","_","urls"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AvatarUrls"},(0,r.kt)("inlineCode",{parentName:"a"},"AvatarUrls"))),(0,r.kt)("p",null,"Avatar URLs for the user."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L540"},"packages/core/src/data/types/entities.ts:540")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Description of the user."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L525"},"packages/core/src/data/types/entities.ts:525")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"id"},"id"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Unique identifier for the user."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L510"},"packages/core/src/data/types/entities.ts:510")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"link"},"link"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"link"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Author URL of the user."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L530"},"packages/core/src/data/types/entities.ts:530")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,r.kt)("p",null,"Meta fields."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L545"},"packages/core/src/data/types/entities.ts:545")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Display name for the user."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L515"},"packages/core/src/data/types/entities.ts:515")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"An alphanumeric identifier for the user."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L535"},"packages/core/src/data/types/entities.ts:535")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"url"},"url"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"url"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"URL of the user."),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L520"},"packages/core/src/data/types/entities.ts:520")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L548"},"packages/core/src/data/types/entities.ts:548")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L547"},"packages/core/src/data/types/entities.ts:547")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1272],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var l=n.createContext({}),d=function(e){var t=n.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return n.createElement(l.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,l=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),c=d(a),h=r,k=c["".concat(l,".").concat(h)]||c[h]||u[h]||i;return a?n.createElement(k,p(p({ref:t},o),{},{components:a})):n.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[c]="string"==typeof e?e:r,p[1]=s;for(var d=2;d{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.AuthorEntity",title:"Interface: AuthorEntity",sidebar_label:"@headstartwp/core.AuthorEntity",custom_edit_url:null},p=void 0,s={unversionedId:"interfaces/headstartwp_core.AuthorEntity",id:"interfaces/headstartwp_core.AuthorEntity",title:"Interface: AuthorEntity",description:"@headstartwp/core.AuthorEntity",source:"@site/docs/interfaces/headstartwp_core.AuthorEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.AuthorEntity",permalink:"/docs/api/interfaces/headstartwp_core.AuthorEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AuthorEntity",title:"Interface: AuthorEntity",sidebar_label:"@headstartwp/core.AuthorEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AttachmentEntity",permalink:"/docs/api/interfaces/headstartwp_core.AttachmentEntity"},next:{title:"@headstartwp/core.AvatarUrls",permalink:"/docs/api/interfaces/headstartwp_core.AvatarUrls"}},l={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"avatar_urls",id:"avatar_urls",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"link",id:"link",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-9",level:4}],o={toc:d};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AuthorEntity"),(0,r.kt)("p",null,"Interface for entities from the /wp/v2/users endpoint."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"AuthorEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"avatar_urls"},"avatar","_","urls"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"avatar","_","urls"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AvatarUrls"},(0,r.kt)("inlineCode",{parentName:"a"},"AvatarUrls"))),(0,r.kt)("p",null,"Avatar URLs for the user."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L540"},"packages/core/src/data/types/entities.ts:540")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Description of the user."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L525"},"packages/core/src/data/types/entities.ts:525")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"id"},"id"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Unique identifier for the user."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L510"},"packages/core/src/data/types/entities.ts:510")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"link"},"link"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"link"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Author URL of the user."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L530"},"packages/core/src/data/types/entities.ts:530")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,r.kt)("p",null,"Meta fields."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L545"},"packages/core/src/data/types/entities.ts:545")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Display name for the user."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L515"},"packages/core/src/data/types/entities.ts:515")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"An alphanumeric identifier for the user."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L535"},"packages/core/src/data/types/entities.ts:535")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"url"},"url"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"url"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"URL of the user."),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L520"},"packages/core/src/data/types/entities.ts:520")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L548"},"packages/core/src/data/types/entities.ts:548")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L547"},"packages/core/src/data/types/entities.ts:547")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/90fd0dd1.48dae2b4.js b/assets/js/90fd0dd1.fbd0243a.js similarity index 95% rename from assets/js/90fd0dd1.48dae2b4.js rename to assets/js/90fd0dd1.fbd0243a.js index 5c440d1ab..ddc2f5f8d 100644 --- a/assets/js/90fd0dd1.48dae2b4.js +++ b/assets/js/90fd0dd1.fbd0243a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7519],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(r),h=n,m=s["".concat(p,".").concat(h)]||s[h]||k[h]||i;return r?a.createElement(m,l(l({ref:t},d),{},{components:r})):a.createElement(m,l({ref:t},d))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=h;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.FileBlockProps",title:"Interface: FileBlockProps",sidebar_label:"@headstartwp/core.react.FileBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.FileBlockProps",id:"interfaces/headstartwp_core.react.FileBlockProps",title:"Interface: FileBlockProps",description:"@headstartwp/core.react.FileBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.FileBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.FileBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.FileBlockProps",title:"Interface: FileBlockProps",sidebar_label:"@headstartwp/core.react.FileBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.FetchHookOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},next:{title:"@headstartwp/core.react.GroupBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"href",id:"href",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"showDownloadButton",id:"showdownloadbutton",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".FileBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"FileBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"href"},"href"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"href"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/FileBlock.tsx#L8"},"packages/core/src/react/blocks/FileBlock.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"id"},"id"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"id"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/FileBlock.tsx#L7"},"packages/core/src/react/blocks/FileBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"showdownloadbutton"},"showDownloadButton"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"showDownloadButton"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/FileBlock.tsx#L9"},"packages/core/src/react/blocks/FileBlock.tsx:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7519],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(r),h=n,m=s["".concat(p,".").concat(h)]||s[h]||k[h]||i;return r?a.createElement(m,l(l({ref:t},d),{},{components:r})):a.createElement(m,l({ref:t},d))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=h;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.FileBlockProps",title:"Interface: FileBlockProps",sidebar_label:"@headstartwp/core.react.FileBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.FileBlockProps",id:"interfaces/headstartwp_core.react.FileBlockProps",title:"Interface: FileBlockProps",description:"@headstartwp/core.react.FileBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.FileBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.FileBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.FileBlockProps",title:"Interface: FileBlockProps",sidebar_label:"@headstartwp/core.react.FileBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.FetchHookOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},next:{title:"@headstartwp/core.react.GroupBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"href",id:"href",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"showDownloadButton",id:"showdownloadbutton",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".FileBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"FileBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"href"},"href"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"href"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/FileBlock.tsx#L8"},"packages/core/src/react/blocks/FileBlock.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"id"},"id"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"id"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/FileBlock.tsx#L7"},"packages/core/src/react/blocks/FileBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"showdownloadbutton"},"showDownloadButton"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"showDownloadButton"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/FileBlock.tsx#L9"},"packages/core/src/react/blocks/FileBlock.tsx:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/912e5e58.40a40afe.js b/assets/js/912e5e58.95de57fa.js similarity index 84% rename from assets/js/912e5e58.40a40afe.js rename to assets/js/912e5e58.95de57fa.js index a4134e8b9..a2f307bdb 100644 --- a/assets/js/912e5e58.40a40afe.js +++ b/assets/js/912e5e58.95de57fa.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1362],{3905:(e,t,r)=>{r.d(t,{Zo:()=>i,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var c=a.createContext({}),p=function(e){var t=a.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},i=function(e){var t=p(e.components);return a.createElement(c.Provider,{value:t},e.children)},d="mdxType",f={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,c=e.parentName,i=s(e,["components","mdxType","originalType","parentName"]),d=p(r),u=n,m=d["".concat(c,".").concat(u)]||d[u]||f[u]||o;return r?a.createElement(m,l(l({ref:t},i),{},{components:r})):a.createElement(m,l({ref:t},i))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,l=new Array(o);l[0]=u;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s[d]="string"==typeof e?e:n,l[1]=s;for(var p=2;p{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.SafeHtmlProps",title:"Interface: SafeHtmlProps",sidebar_label:"@headstartwp/core.react.SafeHtmlProps",custom_edit_url:null},l=void 0,s={unversionedId:"interfaces/headstartwp_core.react.SafeHtmlProps",id:"interfaces/headstartwp_core.react.SafeHtmlProps",title:"Interface: SafeHtmlProps",description:"@headstartwp/core.react.SafeHtmlProps",source:"@site/docs/interfaces/headstartwp_core.react.SafeHtmlProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.SafeHtmlProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.SafeHtmlProps",title:"Interface: SafeHtmlProps",sidebar_label:"@headstartwp/core.react.SafeHtmlProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.QuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},next:{title:"@headstartwp/core.react.SeparatorBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"}},c={},p=[{value:"Properties",id:"properties",level:2},{value:"html",id:"html",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ksesAllowList",id:"ksesallowlist",level:3},{value:"Defined in",id:"defined-in-1",level:4}],i={toc:p};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},i,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".SafeHtmlProps"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"html"},"html"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"html"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The HTML string to be rendered."),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-jsx"},'\n')),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/SafeHtml.tsx#L14"},"packages/core/src/react/components/SafeHtml.tsx:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ksesallowlist"},"ksesAllowList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"ksesAllowList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"IWhiteList")),(0,n.kt)("p",null,"The allow list for the parser"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-jsx"},'\n')),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/SafeHtml.tsx#L26"},"packages/core/src/react/components/SafeHtml.tsx:26")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1362],{3905:(e,t,r)=>{r.d(t,{Zo:()=>i,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},i=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",f={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,i=s(e,["components","mdxType","originalType","parentName"]),d=c(r),u=n,m=d["".concat(p,".").concat(u)]||d[u]||f[u]||o;return r?a.createElement(m,l(l({ref:t},i),{},{components:r})):a.createElement(m,l({ref:t},i))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,l=new Array(o);l[0]=u;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[d]="string"==typeof e?e:n,l[1]=s;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.SafeHtmlProps",title:"Interface: SafeHtmlProps",sidebar_label:"@headstartwp/core.react.SafeHtmlProps",custom_edit_url:null},l=void 0,s={unversionedId:"interfaces/headstartwp_core.react.SafeHtmlProps",id:"interfaces/headstartwp_core.react.SafeHtmlProps",title:"Interface: SafeHtmlProps",description:"@headstartwp/core.react.SafeHtmlProps",source:"@site/docs/interfaces/headstartwp_core.react.SafeHtmlProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.SafeHtmlProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.SafeHtmlProps",title:"Interface: SafeHtmlProps",sidebar_label:"@headstartwp/core.react.SafeHtmlProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.QuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},next:{title:"@headstartwp/core.react.SeparatorBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"}},p={},c=[{value:"Properties",id:"properties",level:2},{value:"html",id:"html",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ksesAllowList",id:"ksesallowlist",level:3},{value:"Defined in",id:"defined-in-1",level:4}],i={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},i,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".SafeHtmlProps"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"html"},"html"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"html"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The HTML string to be rendered."),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-jsx"},'\n')),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/SafeHtml.tsx#L14"},"packages/core/src/react/components/SafeHtml.tsx:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ksesallowlist"},"ksesAllowList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"ksesAllowList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"IWhiteList")),(0,n.kt)("p",null,"The allow list for the parser"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-jsx"},'\n')),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/SafeHtml.tsx#L26"},"packages/core/src/react/components/SafeHtml.tsx:26")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/92bb2d44.8d4d0d22.js b/assets/js/92bb2d44.102156de.js similarity index 97% rename from assets/js/92bb2d44.8d4d0d22.js rename to assets/js/92bb2d44.102156de.js index a9ab24fda..8d43f274d 100644 --- a/assets/js/92bb2d44.8d4d0d22.js +++ b/assets/js/92bb2d44.102156de.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7775],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.ISeparatorBlock",title:"Interface: ISeparatorBlock",sidebar_label:"@headstartwp/core.react.ISeparatorBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.ISeparatorBlock",id:"interfaces/headstartwp_core.react.ISeparatorBlock",title:"Interface: ISeparatorBlock",description:"@headstartwp/core.react.ISeparatorBlock",source:"@site/docs/interfaces/headstartwp_core.react.ISeparatorBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ISeparatorBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ISeparatorBlock",title:"Interface: ISeparatorBlock",sidebar_label:"@headstartwp/core.react.ISeparatorBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock"},next:{title:"@headstartwp/core.react.ISpacerBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ISeparatorBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SeparatorBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ISeparatorBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SeparatorBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SeparatorBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7775],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.ISeparatorBlock",title:"Interface: ISeparatorBlock",sidebar_label:"@headstartwp/core.react.ISeparatorBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.ISeparatorBlock",id:"interfaces/headstartwp_core.react.ISeparatorBlock",title:"Interface: ISeparatorBlock",description:"@headstartwp/core.react.ISeparatorBlock",source:"@site/docs/interfaces/headstartwp_core.react.ISeparatorBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ISeparatorBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ISeparatorBlock",title:"Interface: ISeparatorBlock",sidebar_label:"@headstartwp/core.react.ISeparatorBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock"},next:{title:"@headstartwp/core.react.ISpacerBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ISeparatorBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SeparatorBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ISeparatorBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SeparatorBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SeparatorBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/93679912.7917b00a.js b/assets/js/93679912.3d432960.js similarity index 97% rename from assets/js/93679912.7917b00a.js rename to assets/js/93679912.3d432960.js index 0af82a8bb..8c06a2db6 100644 --- a/assets/js/93679912.7917b00a.js +++ b/assets/js/93679912.3d432960.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7870],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var l=r.createContext({}),d=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return r.createElement(l.Provider,{value:t},e.children)},h="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),h=d(a),m=n,k=h["".concat(l,".").concat(m)]||h[m]||c[m]||i;return a?r.createElement(k,p(p({ref:t},o),{},{components:a})):r.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[h]="string"==typeof e?e:n,p[1]=s;for(var d=2;d{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>h,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.SearchFetchStrategy",title:"Class: SearchFetchStrategy",sidebar_label:"@headstartwp/core.SearchFetchStrategy",custom_edit_url:null},p=void 0,s={unversionedId:"classes/headstartwp_core.SearchFetchStrategy",id:"classes/headstartwp_core.SearchFetchStrategy",title:"Class: SearchFetchStrategy",description:"@headstartwp/core.SearchFetchStrategy",source:"@site/docs/classes/headstartwp_core.SearchFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.SearchFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SearchFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.SearchFetchStrategy",title:"Class: SearchFetchStrategy",sidebar_label:"@headstartwp/core.SearchFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.ProcessingInstruction",permalink:"/docs/api/classes/headstartwp_core.ProcessingInstruction"},next:{title:"@headstartwp/core.SinglePostFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"}},l={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"locale",id:"locale",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"path",id:"path",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-21",level:4}],o={toc:d};function h(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".SearchFetchStrategy"),(0,n.kt)("p",null,"The SearchFetchStrategy extends the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy")," and does not make use of the\nsearch endpoint. Instead it uses the specified postType endpoint."),(0,n.kt)("p",null,"This strategy supports extracting endpoint params from url E.g:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/page/2/")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ page: 2 }")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/searched-term/page/2")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ search: 'searched-term', page: 2 }"))),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SearchFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new SearchFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L115"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:115")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L105"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:105")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L110"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:110")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"locale"},"locale"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"locale"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#locale"},"locale")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L212"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"path"},"path"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"path"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#path"},"path")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L210"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Handles taxonomy filters and switch endpoint based on post type"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L289"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[] }",">"),(0,n.kt)("p",null,"The fetcher function is overridden to disable throwing if not found"),(0,n.kt)("p",null,"If a search request returns not found we do not want to redirect to a 404 page,\ninstead the user should be informed that no posts were found"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The url to parse")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"FetchOptions")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[] }",">"),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/SearchFetchStrategy.ts#L46"},"packages/core/src/data/strategies/SearchFetchStrategy.ts:46")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L530"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L404"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:404")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L227"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:227")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L369"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:369")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/SearchFetchStrategy.ts#L24"},"packages/core/src/data/strategies/SearchFetchStrategy.ts:24")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L218"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL"),(0,n.kt)("p",null,"It also takes into account the custom taxonomies specified in ",(0,n.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL path to extract params from")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"})))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/SearchFetchStrategy.ts#L28"},"packages/core/src/data/strategies/SearchFetchStrategy.ts:28")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("p",null,"Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)"),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The response from the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L461"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L191"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:191")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L379"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:379")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L327"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L150"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:150")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L146"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:146")))}h.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7870],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var l=r.createContext({}),d=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return r.createElement(l.Provider,{value:t},e.children)},h="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),h=d(a),m=n,k=h["".concat(l,".").concat(m)]||h[m]||c[m]||i;return a?r.createElement(k,p(p({ref:t},o),{},{components:a})):r.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[h]="string"==typeof e?e:n,p[1]=s;for(var d=2;d{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>h,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.SearchFetchStrategy",title:"Class: SearchFetchStrategy",sidebar_label:"@headstartwp/core.SearchFetchStrategy",custom_edit_url:null},p=void 0,s={unversionedId:"classes/headstartwp_core.SearchFetchStrategy",id:"classes/headstartwp_core.SearchFetchStrategy",title:"Class: SearchFetchStrategy",description:"@headstartwp/core.SearchFetchStrategy",source:"@site/docs/classes/headstartwp_core.SearchFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.SearchFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SearchFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.SearchFetchStrategy",title:"Class: SearchFetchStrategy",sidebar_label:"@headstartwp/core.SearchFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.ProcessingInstruction",permalink:"/docs/api/classes/headstartwp_core.ProcessingInstruction"},next:{title:"@headstartwp/core.SinglePostFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"}},l={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"locale",id:"locale",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"path",id:"path",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-21",level:4}],o={toc:d};function h(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".SearchFetchStrategy"),(0,n.kt)("p",null,"The SearchFetchStrategy extends the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy")," and does not make use of the\nsearch endpoint. Instead it uses the specified postType endpoint."),(0,n.kt)("p",null,"This strategy supports extracting endpoint params from url E.g:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/page/2/")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ page: 2 }")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/searched-term/page/2")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ search: 'searched-term', page: 2 }"))),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SearchFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new SearchFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L115"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:115")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L105"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:105")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L110"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:110")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"locale"},"locale"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"locale"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#locale"},"locale")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L212"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"path"},"path"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"path"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#path"},"path")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L210"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Handles taxonomy filters and switch endpoint based on post type"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L289"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[] }",">"),(0,n.kt)("p",null,"The fetcher function is overridden to disable throwing if not found"),(0,n.kt)("p",null,"If a search request returns not found we do not want to redirect to a 404 page,\ninstead the user should be informed that no posts were found"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The url to parse")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"FetchOptions")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[] }",">"),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/SearchFetchStrategy.ts#L46"},"packages/core/src/data/strategies/SearchFetchStrategy.ts:46")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L530"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L404"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:404")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L227"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:227")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L369"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:369")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/SearchFetchStrategy.ts#L24"},"packages/core/src/data/strategies/SearchFetchStrategy.ts:24")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L218"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL"),(0,n.kt)("p",null,"It also takes into account the custom taxonomies specified in ",(0,n.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL path to extract params from")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"})))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/SearchFetchStrategy.ts#L28"},"packages/core/src/data/strategies/SearchFetchStrategy.ts:28")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("p",null,"Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)"),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The response from the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L461"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L191"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:191")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L379"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:379")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L327"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L150"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:150")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L146"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:146")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/950ec5f2.65247023.js b/assets/js/950ec5f2.629856cf.js similarity index 96% rename from assets/js/950ec5f2.65247023.js rename to assets/js/950ec5f2.629856cf.js index 62611b44c..09da48396 100644 --- a/assets/js/950ec5f2.65247023.js +++ b/assets/js/950ec5f2.629856cf.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4909],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var l=r.createContext({}),d=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return r.createElement(l.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),c=d(a),m=n,k=c["".concat(l,".").concat(m)]||c[m]||h[m]||i;return a?r.createElement(k,p(p({ref:t},o),{},{components:a})):r.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[c]="string"==typeof e?e:n,p[1]=s;for(var d=2;d{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.PostsArchiveFetchStrategy",title:"Class: PostsArchiveFetchStrategy",sidebar_label:"@headstartwp/core.PostsArchiveFetchStrategy",custom_edit_url:null},p=void 0,s={unversionedId:"classes/headstartwp_core.PostsArchiveFetchStrategy",id:"classes/headstartwp_core.PostsArchiveFetchStrategy",title:"Class: PostsArchiveFetchStrategy",description:"@headstartwp/core.PostsArchiveFetchStrategy",source:"@site/docs/classes/headstartwp_core.PostsArchiveFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.PostsArchiveFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostsArchiveFetchStrategy",title:"Class: PostsArchiveFetchStrategy",sidebar_label:"@headstartwp/core.PostsArchiveFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostOrPostsFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy"},next:{title:"@headstartwp/core.ProcessingInstruction",permalink:"/docs/api/classes/headstartwp_core.ProcessingInstruction"}},l={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"locale",id:"locale",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"path",id:"path",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-5",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Overrides",id:"overrides-6",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Overrides",id:"overrides-7",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-21",level:4}],o={toc:d};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostsArchiveFetchStrategy"),(0,n.kt)("p",null,"The PostsArchiveFetchStrategy is used to fetch a collection of posts from any post type.\nNote that custom post types and custom taxonomies should be defined in ",(0,n.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,n.kt)("p",null,"This strategy supports extracting endpoint params from url E.g:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/category/cat-name/page/2")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ category: 'cat-name', page: 2 }")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/page/2/")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ page: 2 }")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/genre/genre-name/page/2")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ genre: 'genre-name', page: 2 }")," if a ",(0,n.kt)("inlineCode",{parentName:"li"},"genre")," taxonomy is defined in ",(0,n.kt)("inlineCode",{parentName:"li"},"headless.config.js"))),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"See"))),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getparamsfromurl"},"getParamsFromURL")," to learn about url param mapping"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PostsArchiveFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SearchFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"SearchFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AuthorArchiveFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new PostsArchiveFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L115"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:115")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L105"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:105")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L110"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:110")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"locale"},"locale"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"locale"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L212"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"path"},"path"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"path"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L210"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Handles taxonomy filters and switch endpoint based on post type"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L289"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"Before fetching posts, we need handle taxonomy and authors."),(0,n.kt)("p",null,"If the headless plugin is not being used, then additional requests needs to be made to get\nauthors and terms ids"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to parse")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"FetchOptions")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L393"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:393")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L530"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L404"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:404")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L227"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:227")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L369"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:369")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-3"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L214"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:214")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-4"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L218"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL"),(0,n.kt)("p",null,"It also takes into account the custom taxonomies specified in ",(0,n.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL path to extract params from")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"})))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-5"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L230"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:230")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("p",null,"Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)"),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The response from the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("h4",{id:"overrides-6"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L461"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L191"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:191")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L379"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:379")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"overrides-7"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L327"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L150"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:150")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L146"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:146")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4909],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var l=r.createContext({}),d=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return r.createElement(l.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),c=d(a),m=n,k=c["".concat(l,".").concat(m)]||c[m]||h[m]||i;return a?r.createElement(k,p(p({ref:t},o),{},{components:a})):r.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[c]="string"==typeof e?e:n,p[1]=s;for(var d=2;d{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.PostsArchiveFetchStrategy",title:"Class: PostsArchiveFetchStrategy",sidebar_label:"@headstartwp/core.PostsArchiveFetchStrategy",custom_edit_url:null},p=void 0,s={unversionedId:"classes/headstartwp_core.PostsArchiveFetchStrategy",id:"classes/headstartwp_core.PostsArchiveFetchStrategy",title:"Class: PostsArchiveFetchStrategy",description:"@headstartwp/core.PostsArchiveFetchStrategy",source:"@site/docs/classes/headstartwp_core.PostsArchiveFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.PostsArchiveFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostsArchiveFetchStrategy",title:"Class: PostsArchiveFetchStrategy",sidebar_label:"@headstartwp/core.PostsArchiveFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostOrPostsFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy"},next:{title:"@headstartwp/core.ProcessingInstruction",permalink:"/docs/api/classes/headstartwp_core.ProcessingInstruction"}},l={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"locale",id:"locale",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"path",id:"path",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-5",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Overrides",id:"overrides-6",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Overrides",id:"overrides-7",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-21",level:4}],o={toc:d};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostsArchiveFetchStrategy"),(0,n.kt)("p",null,"The PostsArchiveFetchStrategy is used to fetch a collection of posts from any post type.\nNote that custom post types and custom taxonomies should be defined in ",(0,n.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,n.kt)("p",null,"This strategy supports extracting endpoint params from url E.g:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/category/cat-name/page/2")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ category: 'cat-name', page: 2 }")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/page/2/")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ page: 2 }")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/genre/genre-name/page/2")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ genre: 'genre-name', page: 2 }")," if a ",(0,n.kt)("inlineCode",{parentName:"li"},"genre")," taxonomy is defined in ",(0,n.kt)("inlineCode",{parentName:"li"},"headless.config.js"))),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"See"))),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getparamsfromurl"},"getParamsFromURL")," to learn about url param mapping"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PostsArchiveFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SearchFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"SearchFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AuthorArchiveFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new PostsArchiveFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L115"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:115")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L105"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:105")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L110"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:110")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"locale"},"locale"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"locale"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L212"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"path"},"path"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"path"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L210"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Handles taxonomy filters and switch endpoint based on post type"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L289"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"Before fetching posts, we need handle taxonomy and authors."),(0,n.kt)("p",null,"If the headless plugin is not being used, then additional requests needs to be made to get\nauthors and terms ids"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to parse")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"FetchOptions")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L393"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:393")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L530"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L404"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:404")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L227"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:227")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L369"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:369")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-3"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L214"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:214")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-4"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L218"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL"),(0,n.kt)("p",null,"It also takes into account the custom taxonomies specified in ",(0,n.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL path to extract params from")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"})))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-5"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L230"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:230")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("p",null,"Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)"),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The response from the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("h4",{id:"overrides-6"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L461"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L191"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:191")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L379"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:379")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"overrides-7"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L327"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L150"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:150")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L146"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:146")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/960bca7a.49402b10.js b/assets/js/960bca7a.61fc22ea.js similarity index 94% rename from assets/js/960bca7a.49402b10.js rename to assets/js/960bca7a.61fc22ea.js index 299571479..0ec4e95d0 100644 --- a/assets/js/960bca7a.49402b10.js +++ b/assets/js/960bca7a.61fc22ea.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6809],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>f});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var s=n.createContext({}),p=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},c=function(e){var t=p(e.components);return n.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),d=p(r),m=a,f=d["".concat(s,".").concat(m)]||d[m]||u[m]||i;return r?n.createElement(f,o(o({ref:t},c),{},{components:r})):n.createElement(f,o({ref:t},c))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,o=new Array(i);o[0]=m;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[d]="string"==typeof e?e:a,o[1]=l;for(var p=2;p{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const i={id:"headstartwp_core.LOGTYPE",title:"Enumeration: LOGTYPE",sidebar_label:"@headstartwp/core.LOGTYPE",custom_edit_url:null},o=void 0,l={unversionedId:"enums/headstartwp_core.LOGTYPE",id:"enums/headstartwp_core.LOGTYPE",title:"Enumeration: LOGTYPE",description:"@headstartwp/core.LOGTYPE",source:"@site/docs/enums/headstartwp_core.LOGTYPE.md",sourceDirName:"enums",slug:"/enums/headstartwp_core.LOGTYPE",permalink:"/docs/api/enums/headstartwp_core.LOGTYPE",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.LOGTYPE",title:"Enumeration: LOGTYPE",sidebar_label:"@headstartwp/core.LOGTYPE",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/next.middlewares",permalink:"/docs/api/namespaces/headstartwp_next.middlewares"},next:{title:"@headstartwp/core.AbstractFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"}},s={},p=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"DEBUG",id:"debug",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ERROR",id:"error",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"INFO",id:"info",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"WARN",id:"warn",level:3},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:p};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".LOGTYPE"),(0,a.kt)("h2",{id:"enumeration-members"},"Enumeration Members"),(0,a.kt)("h3",{id:"debug"},"DEBUG"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"DEBUG")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"0")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/log.ts#L3"},"packages/core/src/utils/log.ts:3")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"error"},"ERROR"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"ERROR")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"3")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/log.ts#L6"},"packages/core/src/utils/log.ts:6")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"info"},"INFO"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"INFO")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"1")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/log.ts#L4"},"packages/core/src/utils/log.ts:4")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"warn"},"WARN"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"WARN")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"2")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/log.ts#L5"},"packages/core/src/utils/log.ts:5")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6809],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>f});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var s=n.createContext({}),p=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},c=function(e){var t=p(e.components);return n.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),d=p(r),m=a,f=d["".concat(s,".").concat(m)]||d[m]||u[m]||i;return r?n.createElement(f,o(o({ref:t},c),{},{components:r})):n.createElement(f,o({ref:t},c))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,o=new Array(i);o[0]=m;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[d]="string"==typeof e?e:a,o[1]=l;for(var p=2;p{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const i={id:"headstartwp_core.LOGTYPE",title:"Enumeration: LOGTYPE",sidebar_label:"@headstartwp/core.LOGTYPE",custom_edit_url:null},o=void 0,l={unversionedId:"enums/headstartwp_core.LOGTYPE",id:"enums/headstartwp_core.LOGTYPE",title:"Enumeration: LOGTYPE",description:"@headstartwp/core.LOGTYPE",source:"@site/docs/enums/headstartwp_core.LOGTYPE.md",sourceDirName:"enums",slug:"/enums/headstartwp_core.LOGTYPE",permalink:"/docs/api/enums/headstartwp_core.LOGTYPE",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.LOGTYPE",title:"Enumeration: LOGTYPE",sidebar_label:"@headstartwp/core.LOGTYPE",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/next.middlewares",permalink:"/docs/api/namespaces/headstartwp_next.middlewares"},next:{title:"@headstartwp/core.AbstractFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"}},s={},p=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"DEBUG",id:"debug",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ERROR",id:"error",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"INFO",id:"info",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"WARN",id:"warn",level:3},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:p};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".LOGTYPE"),(0,a.kt)("h2",{id:"enumeration-members"},"Enumeration Members"),(0,a.kt)("h3",{id:"debug"},"DEBUG"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"DEBUG")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"0")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/log.ts#L3"},"packages/core/src/utils/log.ts:3")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"error"},"ERROR"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"ERROR")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"3")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/log.ts#L6"},"packages/core/src/utils/log.ts:6")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"info"},"INFO"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"INFO")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"1")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/log.ts#L4"},"packages/core/src/utils/log.ts:4")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"warn"},"WARN"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"WARN")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"2")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/log.ts#L5"},"packages/core/src/utils/log.ts:5")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/966ac8d5.bb9c0fa3.js b/assets/js/966ac8d5.ba372a6a.js similarity index 90% rename from assets/js/966ac8d5.bb9c0fa3.js rename to assets/js/966ac8d5.ba372a6a.js index 4e2bb4dc1..08a0d05b6 100644 --- a/assets/js/966ac8d5.bb9c0fa3.js +++ b/assets/js/966ac8d5.ba372a6a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2900],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>m});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),h=n,m=s["".concat(p,".").concat(h)]||s[h]||k[h]||i;return a?r.createElement(m,l(l({ref:t},d),{},{components:a})):r.createElement(m,l({ref:t},d))}));function m(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=h;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.CoverBlockProps",title:"Interface: CoverBlockProps",sidebar_label:"@headstartwp/core.react.CoverBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.CoverBlockProps",id:"interfaces/headstartwp_core.react.CoverBlockProps",title:"Interface: CoverBlockProps",description:"@headstartwp/core.react.CoverBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.CoverBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.CoverBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.CoverBlockProps",title:"Interface: CoverBlockProps",sidebar_label:"@headstartwp/core.react.CoverBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ColumnsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},next:{title:"@headstartwp/core.react.FetchHookOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"dimRatio",id:"dimratio",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"focalPoint",id:"focalpoint",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"hasParallax",id:"hasparallax",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"isDark",id:"isdark",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"isRepeated",id:"isrepeated",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"minHeight",id:"minheight",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"overlayColor",id:"overlaycolor",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-15",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".CoverBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"CoverBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"dimratio"},"dimRatio"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"dimRatio"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/CoverBlock.tsx#L12"},"packages/core/src/react/blocks/CoverBlock.tsx:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"focalpoint"},"focalPoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"focalPoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"x")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"number"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"y")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"number"))))),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/CoverBlock.tsx#L16"},"packages/core/src/react/blocks/CoverBlock.tsx:16")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"hasparallax"},"hasParallax"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"hasParallax"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/CoverBlock.tsx#L9"},"packages/core/src/react/blocks/CoverBlock.tsx:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"id"},"id"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"id"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/CoverBlock.tsx#L11"},"packages/core/src/react/blocks/CoverBlock.tsx:11")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"isdark"},"isDark"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isDark"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/CoverBlock.tsx#L13"},"packages/core/src/react/blocks/CoverBlock.tsx:13")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"isrepeated"},"isRepeated"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isRepeated"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/CoverBlock.tsx#L10"},"packages/core/src/react/blocks/CoverBlock.tsx:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"minheight"},"minHeight"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"minHeight"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/CoverBlock.tsx#L15"},"packages/core/src/react/blocks/CoverBlock.tsx:15")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"overlaycolor"},"overlayColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"overlayColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/CoverBlock.tsx#L8"},"packages/core/src/react/blocks/CoverBlock.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"url"},"url"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"url"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/CoverBlock.tsx#L14"},"packages/core/src/react/blocks/CoverBlock.tsx:14")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2900],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>m});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),d=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),s=d(a),h=n,m=s["".concat(p,".").concat(h)]||s[h]||k[h]||i;return a?r.createElement(m,l(l({ref:t},c),{},{components:a})):r.createElement(m,l({ref:t},c))}));function m(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=h;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.CoverBlockProps",title:"Interface: CoverBlockProps",sidebar_label:"@headstartwp/core.react.CoverBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.CoverBlockProps",id:"interfaces/headstartwp_core.react.CoverBlockProps",title:"Interface: CoverBlockProps",description:"@headstartwp/core.react.CoverBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.CoverBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.CoverBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.CoverBlockProps",title:"Interface: CoverBlockProps",sidebar_label:"@headstartwp/core.react.CoverBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ColumnsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},next:{title:"@headstartwp/core.react.FetchHookOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"dimRatio",id:"dimratio",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"focalPoint",id:"focalpoint",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"hasParallax",id:"hasparallax",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"isDark",id:"isdark",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"isRepeated",id:"isrepeated",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"minHeight",id:"minheight",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"overlayColor",id:"overlaycolor",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-15",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".CoverBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"CoverBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"dimratio"},"dimRatio"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"dimRatio"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/CoverBlock.tsx#L12"},"packages/core/src/react/blocks/CoverBlock.tsx:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"focalpoint"},"focalPoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"focalPoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"x")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"number"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"y")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"number"))))),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/CoverBlock.tsx#L16"},"packages/core/src/react/blocks/CoverBlock.tsx:16")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"hasparallax"},"hasParallax"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"hasParallax"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/CoverBlock.tsx#L9"},"packages/core/src/react/blocks/CoverBlock.tsx:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"id"},"id"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"id"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/CoverBlock.tsx#L11"},"packages/core/src/react/blocks/CoverBlock.tsx:11")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"isdark"},"isDark"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isDark"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/CoverBlock.tsx#L13"},"packages/core/src/react/blocks/CoverBlock.tsx:13")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"isrepeated"},"isRepeated"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isRepeated"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/CoverBlock.tsx#L10"},"packages/core/src/react/blocks/CoverBlock.tsx:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"minheight"},"minHeight"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"minHeight"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/CoverBlock.tsx#L15"},"packages/core/src/react/blocks/CoverBlock.tsx:15")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"overlaycolor"},"overlayColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"overlayColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/CoverBlock.tsx#L8"},"packages/core/src/react/blocks/CoverBlock.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"url"},"url"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"url"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/CoverBlock.tsx#L14"},"packages/core/src/react/blocks/CoverBlock.tsx:14")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9689b62a.cf24f134.js b/assets/js/9689b62a.ce24ba9b.js similarity index 82% rename from assets/js/9689b62a.cf24f134.js rename to assets/js/9689b62a.ce24ba9b.js index bf7ec159a..c11348c06 100644 --- a/assets/js/9689b62a.cf24f134.js +++ b/assets/js/9689b62a.ce24ba9b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7244],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var c=n.createContext({}),p=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},s=function(e){var t=p(e.components);return n.createElement(c.Provider,{value:t},e.children)},l="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,c=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),l=p(r),f=a,m=l["".concat(c,".").concat(f)]||l[f]||u[f]||o;return r?n.createElement(m,i(i({ref:t},s),{},{components:r})):n.createElement(m,i({ref:t},s))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=f;var d={};for(var c in t)hasOwnProperty.call(t,c)&&(d[c]=t[c]);d.originalType=e,d[l]="string"==typeof e?e:a,i[1]=d;for(var p=2;p{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>d,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const o={id:"headstartwp_core.Rendered",title:"Interface: Rendered",sidebar_label:"@headstartwp/core.Rendered",custom_edit_url:null},i=void 0,d={unversionedId:"interfaces/headstartwp_core.Rendered",id:"interfaces/headstartwp_core.Rendered",title:"Interface: Rendered",description:"@headstartwp/core.Rendered",source:"@site/docs/interfaces/headstartwp_core.Rendered.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.Rendered",permalink:"/docs/api/interfaces/headstartwp_core.Rendered",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.Rendered",title:"Interface: Rendered",sidebar_label:"@headstartwp/core.Rendered",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostsArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},next:{title:"@headstartwp/core.RevisionEntity",permalink:"/docs/api/interfaces/headstartwp_core.RevisionEntity"}},c={},p=[{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"rendered",id:"rendered",level:3},{value:"Defined in",id:"defined-in",level:4}],s={toc:p};function l(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".Rendered"),(0,a.kt)("p",null,"Cover some cases of objects with ",(0,a.kt)("inlineCode",{parentName:"p"},"rendered")," property."),(0,a.kt)("h2",{id:"indexable"},"Indexable"),(0,a.kt)("p",null,"\u25aa ","[k: ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"rendered"},"rendered"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"rendered"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Property of the object, transformed for display."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L25"},"packages/core/src/data/types/entities.ts:25")))}l.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7244],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),c=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},s=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},l="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,p=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),l=c(r),f=a,m=l["".concat(p,".").concat(f)]||l[f]||u[f]||o;return r?n.createElement(m,i(i({ref:t},s),{},{components:r})):n.createElement(m,i({ref:t},s))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=f;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d[l]="string"==typeof e?e:a,i[1]=d;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>d,toc:()=>c});var n=r(7462),a=(r(7294),r(3905));const o={id:"headstartwp_core.Rendered",title:"Interface: Rendered",sidebar_label:"@headstartwp/core.Rendered",custom_edit_url:null},i=void 0,d={unversionedId:"interfaces/headstartwp_core.Rendered",id:"interfaces/headstartwp_core.Rendered",title:"Interface: Rendered",description:"@headstartwp/core.Rendered",source:"@site/docs/interfaces/headstartwp_core.Rendered.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.Rendered",permalink:"/docs/api/interfaces/headstartwp_core.Rendered",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.Rendered",title:"Interface: Rendered",sidebar_label:"@headstartwp/core.Rendered",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostsArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},next:{title:"@headstartwp/core.RevisionEntity",permalink:"/docs/api/interfaces/headstartwp_core.RevisionEntity"}},p={},c=[{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"rendered",id:"rendered",level:3},{value:"Defined in",id:"defined-in",level:4}],s={toc:c};function l(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".Rendered"),(0,a.kt)("p",null,"Cover some cases of objects with ",(0,a.kt)("inlineCode",{parentName:"p"},"rendered")," property."),(0,a.kt)("h2",{id:"indexable"},"Indexable"),(0,a.kt)("p",null,"\u25aa ","[k: ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"rendered"},"rendered"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"rendered"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Property of the object, transformed for display."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L25"},"packages/core/src/data/types/entities.ts:25")))}l.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/96b34eb5.d137e7e1.js b/assets/js/96b34eb5.06a7e2db.js similarity index 95% rename from assets/js/96b34eb5.d137e7e1.js rename to assets/js/96b34eb5.06a7e2db.js index 1aad918c1..338b63621 100644 --- a/assets/js/96b34eb5.d137e7e1.js +++ b/assets/js/96b34eb5.06a7e2db.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9108],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var d=r.createContext({}),o=function(e){var t=r.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=o(e.components);return r.createElement(d.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),s=o(a),m=n,h=s["".concat(d,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},c),{},{components:a})):r.createElement(h,l({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p[s]="string"==typeof e?e:n,l[1]=p;for(var o=2;o{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.MediaTextBlockProps",title:"Interface: MediaTextBlockProps",sidebar_label:"@headstartwp/core.react.MediaTextBlockProps",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.MediaTextBlockProps",id:"interfaces/headstartwp_core.react.MediaTextBlockProps",title:"Interface: MediaTextBlockProps",description:"@headstartwp/core.react.MediaTextBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.MediaTextBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.MediaTextBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.MediaTextBlockProps",title:"Interface: MediaTextBlockProps",sidebar_label:"@headstartwp/core.react.MediaTextBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ListBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},next:{title:"@headstartwp/core.react.ParagraphBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"}},d={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"focalPoint",id:"focalpoint",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"imageFill",id:"imagefill",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"mediaId",id:"mediaid",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"mediaPosition",id:"mediaposition",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"mediaSizeSlug",id:"mediasizeslug",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"mediaType",id:"mediatype",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"mediaWidth",id:"mediawidth",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"verticalAlignment",id:"verticalalignment",level:3},{value:"Defined in",id:"defined-in-14",level:4}],c={toc:o};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".MediaTextBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"MediaTextBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"focalpoint"},"focalPoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"focalPoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"x")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"number"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"y")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"number"))))),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/MediaTextBlock.tsx#L13"},"packages/core/src/react/blocks/MediaTextBlock.tsx:13")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"imagefill"},"imageFill"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"imageFill"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/MediaTextBlock.tsx#L12"},"packages/core/src/react/blocks/MediaTextBlock.tsx:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mediaid"},"mediaId"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"mediaId"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/MediaTextBlock.tsx#L8"},"packages/core/src/react/blocks/MediaTextBlock.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mediaposition"},"mediaPosition"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"mediaPosition"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"left"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"right"')),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/MediaTextBlock.tsx#L7"},"packages/core/src/react/blocks/MediaTextBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mediasizeslug"},"mediaSizeSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"mediaSizeSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/MediaTextBlock.tsx#L10"},"packages/core/src/react/blocks/MediaTextBlock.tsx:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mediatype"},"mediaType"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"mediaType"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"image"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"video"')),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/MediaTextBlock.tsx#L9"},"packages/core/src/react/blocks/MediaTextBlock.tsx:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mediawidth"},"mediaWidth"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"mediaWidth"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/MediaTextBlock.tsx#L11"},"packages/core/src/react/blocks/MediaTextBlock.tsx:11")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"verticalalignment"},"verticalAlignment"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"verticalAlignment"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"center"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"top"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"bottom"')),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/MediaTextBlock.tsx#L17"},"packages/core/src/react/blocks/MediaTextBlock.tsx:17")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9108],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var d=r.createContext({}),o=function(e){var t=r.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=o(e.components);return r.createElement(d.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),s=o(a),m=n,h=s["".concat(d,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},c),{},{components:a})):r.createElement(h,l({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p[s]="string"==typeof e?e:n,l[1]=p;for(var o=2;o{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.MediaTextBlockProps",title:"Interface: MediaTextBlockProps",sidebar_label:"@headstartwp/core.react.MediaTextBlockProps",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.MediaTextBlockProps",id:"interfaces/headstartwp_core.react.MediaTextBlockProps",title:"Interface: MediaTextBlockProps",description:"@headstartwp/core.react.MediaTextBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.MediaTextBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.MediaTextBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.MediaTextBlockProps",title:"Interface: MediaTextBlockProps",sidebar_label:"@headstartwp/core.react.MediaTextBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ListBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},next:{title:"@headstartwp/core.react.ParagraphBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"}},d={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"focalPoint",id:"focalpoint",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"imageFill",id:"imagefill",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"mediaId",id:"mediaid",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"mediaPosition",id:"mediaposition",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"mediaSizeSlug",id:"mediasizeslug",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"mediaType",id:"mediatype",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"mediaWidth",id:"mediawidth",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"verticalAlignment",id:"verticalalignment",level:3},{value:"Defined in",id:"defined-in-14",level:4}],c={toc:o};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".MediaTextBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"MediaTextBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"focalpoint"},"focalPoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"focalPoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"x")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"number"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"y")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"number"))))),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/MediaTextBlock.tsx#L13"},"packages/core/src/react/blocks/MediaTextBlock.tsx:13")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"imagefill"},"imageFill"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"imageFill"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/MediaTextBlock.tsx#L12"},"packages/core/src/react/blocks/MediaTextBlock.tsx:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mediaid"},"mediaId"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"mediaId"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/MediaTextBlock.tsx#L8"},"packages/core/src/react/blocks/MediaTextBlock.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mediaposition"},"mediaPosition"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"mediaPosition"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"left"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"right"')),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/MediaTextBlock.tsx#L7"},"packages/core/src/react/blocks/MediaTextBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mediasizeslug"},"mediaSizeSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"mediaSizeSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/MediaTextBlock.tsx#L10"},"packages/core/src/react/blocks/MediaTextBlock.tsx:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mediatype"},"mediaType"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"mediaType"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"image"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"video"')),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/MediaTextBlock.tsx#L9"},"packages/core/src/react/blocks/MediaTextBlock.tsx:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mediawidth"},"mediaWidth"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"mediaWidth"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/MediaTextBlock.tsx#L11"},"packages/core/src/react/blocks/MediaTextBlock.tsx:11")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"verticalalignment"},"verticalAlignment"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"verticalAlignment"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"center"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"top"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"bottom"')),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/MediaTextBlock.tsx#L17"},"packages/core/src/react/blocks/MediaTextBlock.tsx:17")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9818e328.a948eda4.js b/assets/js/9818e328.62782006.js similarity index 88% rename from assets/js/9818e328.a948eda4.js rename to assets/js/9818e328.62782006.js index 92c74db97..36b25ed33 100644 --- a/assets/js/9818e328.a948eda4.js +++ b/assets/js/9818e328.62782006.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8673],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>h});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var d=n.createContext({}),l=function(e){var t=n.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=l(e.components);return n.createElement(d.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,r=e.originalType,d=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),c=l(a),u=i,h=c["".concat(d,".").concat(u)]||c[u]||k[u]||r;return a?n.createElement(h,p(p({ref:t},o),{},{components:a})):n.createElement(h,p({ref:t},o))}));function h(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=a.length,p=new Array(r);p[0]=u;var s={};for(var d in t)hasOwnProperty.call(t,d)&&(s[d]=t[d]);s.originalType=e,s[c]="string"==typeof e?e:i,p[1]=s;for(var l=2;l{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>c,frontMatter:()=>r,metadata:()=>s,toc:()=>l});var n=a(7462),i=(a(7294),a(3905));const r={id:"headstartwp_core.PostTypeEntity",title:"Interface: PostTypeEntity",sidebar_label:"@headstartwp/core.PostTypeEntity",custom_edit_url:null},p=void 0,s={unversionedId:"interfaces/headstartwp_core.PostTypeEntity",id:"interfaces/headstartwp_core.PostTypeEntity",title:"Interface: PostTypeEntity",description:"@headstartwp/core.PostTypeEntity",source:"@site/docs/interfaces/headstartwp_core.PostTypeEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PostTypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostTypeEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostTypeEntity",title:"Interface: PostTypeEntity",sidebar_label:"@headstartwp/core.PostTypeEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostParams",permalink:"/docs/api/interfaces/headstartwp_core.PostParams"},next:{title:"@headstartwp/core.PostsArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"}},d={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"author",id:"author",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"comment_status",id:"comment_status",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"date",id:"date",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"guid",id:"guid",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"link",id:"link",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"modified",id:"modified",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"modified_gmt",id:"modified_gmt",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"ping_status",id:"ping_status",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"terms",id:"terms",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-17",level:4}],o={toc:l};function c(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostTypeEntity"),(0,i.kt)("p",null,"Base interface for all post type entities."),(0,i.kt)("p",null,"Interfaces that extends from this one are:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},"PostEntity"),"."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PageEntity"},"PageEntity"),"."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.AttachmentEntity"},"AttachmentEntity"),"."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.RevisionEntity"},"RevisionEntity"),".")),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,i.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"PostTypeEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PostEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.RevisionEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"RevisionEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PageEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AttachmentEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AttachmentEntity"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"_embedded"},"_","embedded"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"author")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wp:term")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]")))),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L98"},"packages/core/src/data/types/entities.ts:98")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"author"},"author"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"author"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L94"},"packages/core/src/data/types/entities.ts:94")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"comment_status"},"comment","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"comment","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not comments are open on the object."),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L106"},"packages/core/src/data/types/entities.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date"},"date"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, in the site's timezone."),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L42"},"packages/core/src/data/types/entities.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, as GMT."),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L47"},"packages/core/src/data/types/entities.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"guid"},"guid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"guid"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The globally unique identifier for the object."),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L52"},"packages/core/src/data/types/entities.ts:52")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Unique identifier for the object."),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L67"},"packages/core/src/data/types/entities.ts:67")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"link"},"link"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"link"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the object."),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L72"},"packages/core/src/data/types/entities.ts:72")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified"},"modified"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, in the site's timezone."),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L57"},"packages/core/src/data/types/entities.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified_gmt"},"modified","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, as GMT."),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L62"},"packages/core/src/data/types/entities.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ping_status"},"ping","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ping","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not the object can be pinged."),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L111"},"packages/core/src/data/types/entities.ts:111")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"slug"},"slug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"slug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"An alphanumeric identifier for the object unique to its type."),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L77"},"packages/core/src/data/types/entities.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"private"')),(0,i.kt)("p",null,"A named status for the object."),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L82"},"packages/core/src/data/types/entities.ts:82")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"terms"},"terms"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"terms"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L96"},"packages/core/src/data/types/entities.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The title for the object."),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L92"},"packages/core/src/data/types/entities.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Type of Post for the object."),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L87"},"packages/core/src/data/types/entities.ts:87")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L114"},"packages/core/src/data/types/entities.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"overrides-1"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L113"},"packages/core/src/data/types/entities.ts:113")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8673],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>h});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var s=n.createContext({}),l=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),c=l(a),u=i,h=c["".concat(s,".").concat(u)]||c[u]||k[u]||r;return a?n.createElement(h,p(p({ref:t},o),{},{components:a})):n.createElement(h,p({ref:t},o))}));function h(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=a.length,p=new Array(r);p[0]=u;var d={};for(var s in t)hasOwnProperty.call(t,s)&&(d[s]=t[s]);d.originalType=e,d[c]="string"==typeof e?e:i,p[1]=d;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var n=a(7462),i=(a(7294),a(3905));const r={id:"headstartwp_core.PostTypeEntity",title:"Interface: PostTypeEntity",sidebar_label:"@headstartwp/core.PostTypeEntity",custom_edit_url:null},p=void 0,d={unversionedId:"interfaces/headstartwp_core.PostTypeEntity",id:"interfaces/headstartwp_core.PostTypeEntity",title:"Interface: PostTypeEntity",description:"@headstartwp/core.PostTypeEntity",source:"@site/docs/interfaces/headstartwp_core.PostTypeEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PostTypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostTypeEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostTypeEntity",title:"Interface: PostTypeEntity",sidebar_label:"@headstartwp/core.PostTypeEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostParams",permalink:"/docs/api/interfaces/headstartwp_core.PostParams"},next:{title:"@headstartwp/core.PostsArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"author",id:"author",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"comment_status",id:"comment_status",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"date",id:"date",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"guid",id:"guid",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"link",id:"link",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"modified",id:"modified",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"modified_gmt",id:"modified_gmt",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"ping_status",id:"ping_status",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"terms",id:"terms",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-17",level:4}],o={toc:l};function c(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostTypeEntity"),(0,i.kt)("p",null,"Base interface for all post type entities."),(0,i.kt)("p",null,"Interfaces that extends from this one are:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},"PostEntity"),"."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PageEntity"},"PageEntity"),"."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.AttachmentEntity"},"AttachmentEntity"),"."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.RevisionEntity"},"RevisionEntity"),".")),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,i.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"PostTypeEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PostEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.RevisionEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"RevisionEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PageEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AttachmentEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AttachmentEntity"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"_embedded"},"_","embedded"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"author")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wp:term")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]")))),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L98"},"packages/core/src/data/types/entities.ts:98")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"author"},"author"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"author"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L94"},"packages/core/src/data/types/entities.ts:94")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"comment_status"},"comment","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"comment","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not comments are open on the object."),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L106"},"packages/core/src/data/types/entities.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date"},"date"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, in the site's timezone."),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L42"},"packages/core/src/data/types/entities.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, as GMT."),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L47"},"packages/core/src/data/types/entities.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"guid"},"guid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"guid"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The globally unique identifier for the object."),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L52"},"packages/core/src/data/types/entities.ts:52")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Unique identifier for the object."),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L67"},"packages/core/src/data/types/entities.ts:67")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"link"},"link"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"link"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the object."),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L72"},"packages/core/src/data/types/entities.ts:72")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified"},"modified"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, in the site's timezone."),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L57"},"packages/core/src/data/types/entities.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified_gmt"},"modified","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, as GMT."),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L62"},"packages/core/src/data/types/entities.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ping_status"},"ping","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ping","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not the object can be pinged."),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L111"},"packages/core/src/data/types/entities.ts:111")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"slug"},"slug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"slug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"An alphanumeric identifier for the object unique to its type."),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L77"},"packages/core/src/data/types/entities.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"private"')),(0,i.kt)("p",null,"A named status for the object."),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L82"},"packages/core/src/data/types/entities.ts:82")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"terms"},"terms"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"terms"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L96"},"packages/core/src/data/types/entities.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The title for the object."),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L92"},"packages/core/src/data/types/entities.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Type of Post for the object."),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L87"},"packages/core/src/data/types/entities.ts:87")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L114"},"packages/core/src/data/types/entities.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"overrides-1"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L113"},"packages/core/src/data/types/entities.ts:113")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/99fcc669.6f884d04.js b/assets/js/99fcc669.6414049d.js similarity index 99% rename from assets/js/99fcc669.6f884d04.js rename to assets/js/99fcc669.6414049d.js index 43ae95085..f60a05643 100644 --- a/assets/js/99fcc669.6f884d04.js +++ b/assets/js/99fcc669.6414049d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8115],{3905:(e,t,r)=>{r.d(t,{Zo:()=>h,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var u=n.createContext({}),c=function(e){var t=n.useContext(u),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},h=function(e){var t=c(e.components);return n.createElement(u.Provider,{value:t},e.children)},p="mdxType",l={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,u=e.parentName,h=s(e,["components","mdxType","originalType","parentName"]),p=c(r),d=a,m=p["".concat(u,".").concat(d)]||p[d]||l[d]||o;return r?n.createElement(m,i(i({ref:t},h),{},{components:r})):n.createElement(m,i({ref:t},h))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=d;var s={};for(var u in t)hasOwnProperty.call(t,u)&&(s[u]=t[u]);s.originalType=e,s[p]="string"==typeof e?e:a,i[1]=s;for(var c=2;c{r.r(t),r.d(t,{assets:()=>u,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>s,toc:()=>c});var n=r(7462),a=(r(7294),r(3905));const o={slug:"/data-fetching/useauthorarchive",sidebar_position:3},i="The useAuthorArchive Hook",s={unversionedId:"Data Fetching/useAuthorArchive",id:"Data Fetching/useAuthorArchive",title:"The useAuthorArchive Hook",description:"The useAuthorArchive hook is the Next.js binding for the useFetchAuthorArchive.",source:"@site/documentation/02 - Data Fetching/useAuthorArchive.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/useauthorarchive",permalink:"/docs/learn/data-fetching/useauthorarchive",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/useAuthorArchive.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:3,frontMatter:{slug:"/data-fetching/useauthorarchive",sidebar_position:3},sidebar:"tutorialSidebar",previous:{title:"The usePosts hook",permalink:"/docs/learn/data-fetching/useposts"},next:{title:"The usePostOrPosts hook",permalink:"/docs/learn/data-fetching/use-post-or-posts"}},u={},c=[{value:"Basic Usage (Author Archive)",id:"basic-usage-author-archive",level:2},{value:"Author Archive for Custom Post Type",id:"author-archive-for-custom-post-type",level:2}],h={toc:c};function p(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},h,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"the-useauthorarchive-hook"},"The useAuthorArchive Hook"),(0,a.kt)("blockquote",null,(0,a.kt)("p",{parentName:"blockquote"},"The ",(0,a.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#useauthorarchive"},"useAuthorArchive")," hook is the Next.js binding for the ",(0,a.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchauthorarchive"},"useFetchAuthorArchive"),".")),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"useAuthorArchive")," hook fetches a collection of WordPress posts from a registered post type filtered by an author."),(0,a.kt)("h2",{id:"basic-usage-author-archive"},"Basic Usage (Author Archive)"),(0,a.kt)("p",null,"Assuming a ",(0,a.kt)("inlineCode",{parentName:"p"},"src/pages/author/[...path].js")," route with the following content."),(0,a.kt)("admonition",{type:"info"},(0,a.kt)("p",{parentName:"admonition"},"This example is using the catch-all route ",(0,a.kt)("inlineCode",{parentName:"p"},"[..path].js")," because ",(0,a.kt)("strong",{parentName:"p"},"we do not want")," the ",(0,a.kt)("inlineCode",{parentName:"p"},"/author")," path to be handled by this route.")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/author/[...path].js"',title:'"src/pages/author/[...path].js"'},"import { useAuthorArchive } from '@headstartwp/next';\n\nconst ArchivePage = () => {\n const { loading, error, data } = useAuthorArchive({ per_page: 10 });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n {data?.posts?.map((post) => (\n

{post.title.rendered}

\n ))}\n
\n );\n};\n")),(0,a.kt)("p",null,"The route will automatically render the latest 10 posts from the current author. The following paths will automatically be handled by the hook."),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"/author/author-name"),(0,a.kt)("li",{parentName:"ul"},"/author/author-name/page/2")),(0,a.kt)("h2",{id:"author-archive-for-custom-post-type"},"Author Archive for Custom Post Type"),(0,a.kt)("p",null,"In order to fetch posts from a custom post type, first declare the custom post type in ",(0,a.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," as explained in the ",(0,a.kt)("a",{parentName:"p",href:"/learn/getting-started/headless-config#custom-post-types"},"headstartwp.config.js")," section. "),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/author/[...path].js"',title:'"src/pages/author/[...path].js"'},"import { useAuthorArchive } from '@headstartwp/next';\n\nconst ArchivePage = () => {\n // book must be declared in headstartwp.config.js\n const { loading, error, data } = useAuthorArchive({ postType: ['book'] });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n {data?.posts?.map((post) => (\n

{post.title.rendered}

\n ))}\n
\n );\n};\n")))}p.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8115],{3905:(e,t,r)=>{r.d(t,{Zo:()=>h,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var u=n.createContext({}),c=function(e){var t=n.useContext(u),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},h=function(e){var t=c(e.components);return n.createElement(u.Provider,{value:t},e.children)},p="mdxType",l={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,u=e.parentName,h=s(e,["components","mdxType","originalType","parentName"]),p=c(r),d=a,m=p["".concat(u,".").concat(d)]||p[d]||l[d]||o;return r?n.createElement(m,i(i({ref:t},h),{},{components:r})):n.createElement(m,i({ref:t},h))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=d;var s={};for(var u in t)hasOwnProperty.call(t,u)&&(s[u]=t[u]);s.originalType=e,s[p]="string"==typeof e?e:a,i[1]=s;for(var c=2;c{r.r(t),r.d(t,{assets:()=>u,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>s,toc:()=>c});var n=r(7462),a=(r(7294),r(3905));const o={slug:"/data-fetching/useauthorarchive",sidebar_position:3},i="The useAuthorArchive Hook",s={unversionedId:"Data Fetching/useAuthorArchive",id:"Data Fetching/useAuthorArchive",title:"The useAuthorArchive Hook",description:"The useAuthorArchive hook is the Next.js binding for the useFetchAuthorArchive.",source:"@site/documentation/02 - Data Fetching/useAuthorArchive.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/useauthorarchive",permalink:"/docs/learn/data-fetching/useauthorarchive",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/useAuthorArchive.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:3,frontMatter:{slug:"/data-fetching/useauthorarchive",sidebar_position:3},sidebar:"tutorialSidebar",previous:{title:"The usePosts hook",permalink:"/docs/learn/data-fetching/useposts"},next:{title:"The usePostOrPosts hook",permalink:"/docs/learn/data-fetching/use-post-or-posts"}},u={},c=[{value:"Basic Usage (Author Archive)",id:"basic-usage-author-archive",level:2},{value:"Author Archive for Custom Post Type",id:"author-archive-for-custom-post-type",level:2}],h={toc:c};function p(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},h,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"the-useauthorarchive-hook"},"The useAuthorArchive Hook"),(0,a.kt)("blockquote",null,(0,a.kt)("p",{parentName:"blockquote"},"The ",(0,a.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#useauthorarchive"},"useAuthorArchive")," hook is the Next.js binding for the ",(0,a.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchauthorarchive"},"useFetchAuthorArchive"),".")),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"useAuthorArchive")," hook fetches a collection of WordPress posts from a registered post type filtered by an author."),(0,a.kt)("h2",{id:"basic-usage-author-archive"},"Basic Usage (Author Archive)"),(0,a.kt)("p",null,"Assuming a ",(0,a.kt)("inlineCode",{parentName:"p"},"src/pages/author/[...path].js")," route with the following content."),(0,a.kt)("admonition",{type:"info"},(0,a.kt)("p",{parentName:"admonition"},"This example is using the catch-all route ",(0,a.kt)("inlineCode",{parentName:"p"},"[..path].js")," because ",(0,a.kt)("strong",{parentName:"p"},"we do not want")," the ",(0,a.kt)("inlineCode",{parentName:"p"},"/author")," path to be handled by this route.")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/author/[...path].js"',title:'"src/pages/author/[...path].js"'},"import { useAuthorArchive } from '@headstartwp/next';\n\nconst ArchivePage = () => {\n const { loading, error, data } = useAuthorArchive({ per_page: 10 });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n {data?.posts?.map((post) => (\n

{post.title.rendered}

\n ))}\n
\n );\n};\n")),(0,a.kt)("p",null,"The route will automatically render the latest 10 posts from the current author. The following paths will automatically be handled by the hook."),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"/author/author-name"),(0,a.kt)("li",{parentName:"ul"},"/author/author-name/page/2")),(0,a.kt)("h2",{id:"author-archive-for-custom-post-type"},"Author Archive for Custom Post Type"),(0,a.kt)("p",null,"In order to fetch posts from a custom post type, first declare the custom post type in ",(0,a.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," as explained in the ",(0,a.kt)("a",{parentName:"p",href:"/learn/getting-started/headless-config#custom-post-types"},"headstartwp.config.js")," section. "),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/author/[...path].js"',title:'"src/pages/author/[...path].js"'},"import { useAuthorArchive } from '@headstartwp/next';\n\nconst ArchivePage = () => {\n // book must be declared in headstartwp.config.js\n const { loading, error, data } = useAuthorArchive({ postType: ['book'] });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n {data?.posts?.map((post) => (\n

{post.title.rendered}

\n ))}\n
\n );\n};\n")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9be33a19.74145b3b.js b/assets/js/9be33a19.7c04ed84.js similarity index 90% rename from assets/js/9be33a19.74145b3b.js rename to assets/js/9be33a19.7c04ed84.js index 87bda4dc8..2c7d7cacc 100644 --- a/assets/js/9be33a19.74145b3b.js +++ b/assets/js/9be33a19.7c04ed84.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3131],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function p(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var l=a.createContext({}),c=function(e){var t=a.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},s=function(e){var t=c(e.components);return a.createElement(l.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),d=c(r),m=n,h=d["".concat(l,".").concat(m)]||d[m]||k[m]||i;return r?a.createElement(h,p(p({ref:t},s),{},{components:r})):a.createElement(h,p({ref:t},s))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,p=new Array(i);p[0]=m;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o[d]="string"==typeof e?e:n,p[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.SeparatorBlockProps",title:"Interface: SeparatorBlockProps",sidebar_label:"@headstartwp/core.react.SeparatorBlockProps",custom_edit_url:null},p=void 0,o={unversionedId:"interfaces/headstartwp_core.react.SeparatorBlockProps",id:"interfaces/headstartwp_core.react.SeparatorBlockProps",title:"Interface: SeparatorBlockProps",description:"@headstartwp/core.react.SeparatorBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.SeparatorBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.SeparatorBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.SeparatorBlockProps",title:"Interface: SeparatorBlockProps",sidebar_label:"@headstartwp/core.react.SeparatorBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.SafeHtmlProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps"},next:{title:"@headstartwp/core.react.SettingsCustomAdditionalProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"}},l={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".SeparatorBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SeparatorBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3131],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function p(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var l=a.createContext({}),c=function(e){var t=a.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(l.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(l,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,p(p({ref:t},d),{},{components:r})):a.createElement(h,p({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,p=new Array(i);p[0]=m;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o[s]="string"==typeof e?e:n,p[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.SeparatorBlockProps",title:"Interface: SeparatorBlockProps",sidebar_label:"@headstartwp/core.react.SeparatorBlockProps",custom_edit_url:null},p=void 0,o={unversionedId:"interfaces/headstartwp_core.react.SeparatorBlockProps",id:"interfaces/headstartwp_core.react.SeparatorBlockProps",title:"Interface: SeparatorBlockProps",description:"@headstartwp/core.react.SeparatorBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.SeparatorBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.SeparatorBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.SeparatorBlockProps",title:"Interface: SeparatorBlockProps",sidebar_label:"@headstartwp/core.react.SeparatorBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.SafeHtmlProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps"},next:{title:"@headstartwp/core.react.SettingsCustomAdditionalProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"}},l={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".SeparatorBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SeparatorBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9c66ae8c.9e67c269.js b/assets/js/9c66ae8c.2b92896f.js similarity index 99% rename from assets/js/9c66ae8c.9e67c269.js rename to assets/js/9c66ae8c.2b92896f.js index b64d82ea7..c3632c904 100644 --- a/assets/js/9c66ae8c.9e67c269.js +++ b/assets/js/9c66ae8c.2b92896f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1736],{3905:(e,t,a)=>{a.d(t,{Zo:()=>l,kt:()=>N});var p=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);t&&(p=p.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,p)}return a}function o(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(p=0;p=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var i=p.createContext({}),m=function(e){var t=p.useContext(i),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},l=function(e){var t=m(e.components);return p.createElement(i.Provider,{value:t},e.children)},c="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return p.createElement(p.Fragment,{},t)}},k=p.forwardRef((function(e,t){var a=e.components,n=e.mdxType,r=e.originalType,i=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),c=m(a),k=n,N=c["".concat(i,".").concat(k)]||c[k]||d[k]||r;return a?p.createElement(N,o(o({ref:t},l),{},{components:a})):p.createElement(N,o({ref:t},l))}));function N(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var r=a.length,o=new Array(r);o[0]=k;var s={};for(var i in t)hasOwnProperty.call(t,i)&&(s[i]=t[i]);s.originalType=e,s[c]="string"==typeof e?e:n,o[1]=s;for(var m=2;m{a.r(t),a.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>c,frontMatter:()=>r,metadata:()=>s,toc:()=>m});var p=a(7462),n=(a(7294),a(3905));const r={id:"headstartwp_core.react.WpThemeJSON",title:"Interface: WpThemeJSON",sidebar_label:"@headstartwp/core.react.WpThemeJSON",custom_edit_url:null},o=void 0,s={unversionedId:"interfaces/headstartwp_core.react.WpThemeJSON",id:"interfaces/headstartwp_core.react.WpThemeJSON",title:"Interface: WpThemeJSON",description:"@headstartwp/core.react.WpThemeJSON",source:"@site/docs/interfaces/headstartwp_core.react.WpThemeJSON.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.WpThemeJSON",permalink:"/docs/api/interfaces/headstartwp_core.react.WpThemeJSON",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.WpThemeJSON",title:"Interface: WpThemeJSON",sidebar_label:"@headstartwp/core.react.WpThemeJSON",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.VerseBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},next:{title:"@headstartwp/core.react.YoutubeLiteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"}},i={},m=[{value:"Properties",id:"properties",level:2},{value:"$schema",id:"schema",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"customTemplates",id:"customtemplates",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"settings",id:"settings",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"styles",id:"styles",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"templateParts",id:"templateparts",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"version",id:"version",level:3},{value:"Defined in",id:"defined-in-5",level:4}],l={toc:m};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,p.Z)({},l,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".WpThemeJSON"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"schema"},"$schema"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"$schema"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"JSON schema URI for theme.json."),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L99"},"packages/core/src/react/provider/types.ts:99")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"customtemplates"},"customTemplates"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"customTemplates"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"postTypes?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[] ; ",(0,n.kt)("inlineCode",{parentName:"p"},"title"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," }[]"),(0,n.kt)("p",null,"Additional metadata for custom templates defined in the templates folder."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L319"},"packages/core/src/react/provider/types.ts:319")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"settings"},"settings"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"settings"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsProperties"))," & { ",(0,n.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"border?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"radius?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"style?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"width?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"color?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"background?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"custom?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"customDuotone?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"customGradient?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultGradients?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultPalette?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"duotone?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotone"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsDuotone"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"gradients?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradient"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsGradient"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"palette?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpalette"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsColorPalette"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"text?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"custom?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"[k: string]"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsCustomAdditionalProperties")),"; } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"layout?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"contentSize?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"wideSize?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"spacing?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"blockGap?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"margin?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"padding?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"units?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[] } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"typography?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"customFontSize?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"dropCap?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"fontFamilies?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"fontFamily?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,n.kt)("inlineCode",{parentName:"p"},"fontSizes?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"size?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,n.kt)("inlineCode",{parentName:"p"},"fontStyle?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"fontWeight?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"letterSpacing?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"lineHeight?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"textDecoration?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"textTransform?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," } }"),(0,n.kt)("p",null,"Settings for the block editor and individual blocks. These include things like:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"Which customization options should be available to the user."),(0,n.kt)("li",{parentName:"ul"},"The default colors, font sizes... available to the user."),(0,n.kt)("li",{parentName:"ul"},"CSS custom properties and class names used in styles."),(0,n.kt)("li",{parentName:"ul"},"And the default layout of the editor (widths and available alignments).")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L111"},"packages/core/src/react/provider/types.ts:111")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"styles"},"styles"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"styles"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesProperties"))," & { ",(0,n.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"elements?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"h1?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"h2?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"h3?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"h4?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"h5?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"h6?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")," }"),(0,n.kt)("p",null,"Organized way to set CSS properties. Styles in the top-level will be added in the ",(0,n.kt)("inlineCode",{parentName:"p"},"body")," selector."),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L210"},"packages/core/src/react/provider/types.ts:210")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"templateparts"},"templateParts"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"templateParts"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"area?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"title?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," }[]"),(0,n.kt)("p",null,"Additional metadata for template parts defined in the parts folder."),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L336"},"packages/core/src/react/provider/types.ts:336")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"version"},"version"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"version"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"2")),(0,n.kt)("p",null,"Version of theme.json to use."),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/provider/types.ts#L103"},"packages/core/src/react/provider/types.ts:103")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1736],{3905:(e,t,a)=>{a.d(t,{Zo:()=>l,kt:()=>N});var p=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);t&&(p=p.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,p)}return a}function o(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(p=0;p=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var i=p.createContext({}),m=function(e){var t=p.useContext(i),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},l=function(e){var t=m(e.components);return p.createElement(i.Provider,{value:t},e.children)},c="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return p.createElement(p.Fragment,{},t)}},k=p.forwardRef((function(e,t){var a=e.components,n=e.mdxType,r=e.originalType,i=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),c=m(a),k=n,N=c["".concat(i,".").concat(k)]||c[k]||d[k]||r;return a?p.createElement(N,o(o({ref:t},l),{},{components:a})):p.createElement(N,o({ref:t},l))}));function N(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var r=a.length,o=new Array(r);o[0]=k;var s={};for(var i in t)hasOwnProperty.call(t,i)&&(s[i]=t[i]);s.originalType=e,s[c]="string"==typeof e?e:n,o[1]=s;for(var m=2;m{a.r(t),a.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>c,frontMatter:()=>r,metadata:()=>s,toc:()=>m});var p=a(7462),n=(a(7294),a(3905));const r={id:"headstartwp_core.react.WpThemeJSON",title:"Interface: WpThemeJSON",sidebar_label:"@headstartwp/core.react.WpThemeJSON",custom_edit_url:null},o=void 0,s={unversionedId:"interfaces/headstartwp_core.react.WpThemeJSON",id:"interfaces/headstartwp_core.react.WpThemeJSON",title:"Interface: WpThemeJSON",description:"@headstartwp/core.react.WpThemeJSON",source:"@site/docs/interfaces/headstartwp_core.react.WpThemeJSON.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.WpThemeJSON",permalink:"/docs/api/interfaces/headstartwp_core.react.WpThemeJSON",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.WpThemeJSON",title:"Interface: WpThemeJSON",sidebar_label:"@headstartwp/core.react.WpThemeJSON",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.VerseBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},next:{title:"@headstartwp/core.react.YoutubeLiteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"}},i={},m=[{value:"Properties",id:"properties",level:2},{value:"$schema",id:"schema",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"customTemplates",id:"customtemplates",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"settings",id:"settings",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"styles",id:"styles",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"templateParts",id:"templateparts",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"version",id:"version",level:3},{value:"Defined in",id:"defined-in-5",level:4}],l={toc:m};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,p.Z)({},l,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".WpThemeJSON"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"schema"},"$schema"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"$schema"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"JSON schema URI for theme.json."),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L99"},"packages/core/src/react/provider/types.ts:99")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"customtemplates"},"customTemplates"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"customTemplates"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"postTypes?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[] ; ",(0,n.kt)("inlineCode",{parentName:"p"},"title"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," }[]"),(0,n.kt)("p",null,"Additional metadata for custom templates defined in the templates folder."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L319"},"packages/core/src/react/provider/types.ts:319")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"settings"},"settings"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"settings"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsProperties"))," & { ",(0,n.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"border?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"radius?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"style?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"width?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"color?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"background?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"custom?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"customDuotone?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"customGradient?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultGradients?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultPalette?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"duotone?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotone"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsDuotone"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"gradients?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradient"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsGradient"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"palette?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpalette"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsColorPalette"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"text?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"custom?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"[k: string]"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsCustomAdditionalProperties")),"; } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"layout?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"contentSize?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"wideSize?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"spacing?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"blockGap?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"margin?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"padding?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"units?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[] } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"typography?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"customFontSize?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"dropCap?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"fontFamilies?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"fontFamily?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,n.kt)("inlineCode",{parentName:"p"},"fontSizes?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"size?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,n.kt)("inlineCode",{parentName:"p"},"fontStyle?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"fontWeight?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"letterSpacing?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"lineHeight?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"textDecoration?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"textTransform?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," } }"),(0,n.kt)("p",null,"Settings for the block editor and individual blocks. These include things like:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"Which customization options should be available to the user."),(0,n.kt)("li",{parentName:"ul"},"The default colors, font sizes... available to the user."),(0,n.kt)("li",{parentName:"ul"},"CSS custom properties and class names used in styles."),(0,n.kt)("li",{parentName:"ul"},"And the default layout of the editor (widths and available alignments).")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L111"},"packages/core/src/react/provider/types.ts:111")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"styles"},"styles"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"styles"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesProperties"))," & { ",(0,n.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"elements?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"h1?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"h2?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"h3?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"h4?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"h5?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"h6?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")," }"),(0,n.kt)("p",null,"Organized way to set CSS properties. Styles in the top-level will be added in the ",(0,n.kt)("inlineCode",{parentName:"p"},"body")," selector."),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L210"},"packages/core/src/react/provider/types.ts:210")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"templateparts"},"templateParts"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"templateParts"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"area?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"title?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," }[]"),(0,n.kt)("p",null,"Additional metadata for template parts defined in the parts folder."),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L336"},"packages/core/src/react/provider/types.ts:336")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"version"},"version"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"version"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"2")),(0,n.kt)("p",null,"Version of theme.json to use."),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/provider/types.ts#L103"},"packages/core/src/react/provider/types.ts:103")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a0d0f685.8a6337bb.js b/assets/js/a0d0f685.fb40aa1e.js similarity index 95% rename from assets/js/a0d0f685.8a6337bb.js rename to assets/js/a0d0f685.fb40aa1e.js index 0b6c75a8a..1d96bc583 100644 --- a/assets/js/a0d0f685.8a6337bb.js +++ b/assets/js/a0d0f685.fb40aa1e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2424],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var l=r.createContext({}),d=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return r.createElement(l.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),c=d(a),m=n,k=c["".concat(l,".").concat(m)]||c[m]||h[m]||i;return a?r.createElement(k,p(p({ref:t},o),{},{components:a})):r.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[c]="string"==typeof e?e:n,p[1]=s;for(var d=2;d{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.VerifyTokenFetchStrategy",title:"Class: VerifyTokenFetchStrategy",sidebar_label:"@headstartwp/core.VerifyTokenFetchStrategy",custom_edit_url:null},p=void 0,s={unversionedId:"classes/headstartwp_core.VerifyTokenFetchStrategy",id:"classes/headstartwp_core.VerifyTokenFetchStrategy",title:"Class: VerifyTokenFetchStrategy",description:"@headstartwp/core.VerifyTokenFetchStrategy",source:"@site/docs/classes/headstartwp_core.VerifyTokenFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.VerifyTokenFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.VerifyTokenFetchStrategy",title:"Class: VerifyTokenFetchStrategy",sidebar_label:"@headstartwp/core.VerifyTokenFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Text",permalink:"/docs/api/classes/headstartwp_core.Text"},next:{title:"@headstartwp/core.AppEntity",permalink:"/docs/api/interfaces/headstartwp_core.AppEntity"}},l={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-19",level:4}],o={toc:d};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".VerifyTokenFetchStrategy"),(0,n.kt)("p",null,"The Verify Token strategy is used to verify tokens issued by the\nheadless wp plugin"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"VerifyTokenFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new VerifyTokenFetchStrategy"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L115"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:115")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L105"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:105")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L110"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:110")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Builds the final endpoint URL based on the passed parameters"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"},(0,n.kt)("inlineCode",{parentName:"a"},"VerifyTokenParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to add to the request")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The endpoint URL."),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts#L32"},"packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:32")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">",">"),(0,n.kt)("p",null,"The default fetcher function"),(0,n.kt)("p",null,"The default fetcher function handles authentication headers and errors from the API."),(0,n.kt)("p",null,"A custom strategy can override this function to run additional logic before or after the fetch call"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"},(0,n.kt)("inlineCode",{parentName:"a"},"VerifyTokenParams"))),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetcher options")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">",">"),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts#L39"},"packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:39")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L339"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:339")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">",">"),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L404"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:404")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L227"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:227")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L369"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:369")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts#L23"},"packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:23")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L168"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:168")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"overrides-3"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts#L28"},"packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:28")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L327"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L191"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:191")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L379"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:379")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L219"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:219")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L150"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:150")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L146"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:146")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2424],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var d=r.createContext({}),l=function(e){var t=r.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=l(e.components);return r.createElement(d.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),c=l(a),m=n,k=c["".concat(d,".").concat(m)]||c[m]||h[m]||i;return a?r.createElement(k,p(p({ref:t},o),{},{components:a})):r.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=m;var s={};for(var d in t)hasOwnProperty.call(t,d)&&(s[d]=t[d]);s.originalType=e,s[c]="string"==typeof e?e:n,p[1]=s;for(var l=2;l{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.VerifyTokenFetchStrategy",title:"Class: VerifyTokenFetchStrategy",sidebar_label:"@headstartwp/core.VerifyTokenFetchStrategy",custom_edit_url:null},p=void 0,s={unversionedId:"classes/headstartwp_core.VerifyTokenFetchStrategy",id:"classes/headstartwp_core.VerifyTokenFetchStrategy",title:"Class: VerifyTokenFetchStrategy",description:"@headstartwp/core.VerifyTokenFetchStrategy",source:"@site/docs/classes/headstartwp_core.VerifyTokenFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.VerifyTokenFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.VerifyTokenFetchStrategy",title:"Class: VerifyTokenFetchStrategy",sidebar_label:"@headstartwp/core.VerifyTokenFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Text",permalink:"/docs/api/classes/headstartwp_core.Text"},next:{title:"@headstartwp/core.AppEntity",permalink:"/docs/api/interfaces/headstartwp_core.AppEntity"}},d={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-19",level:4}],o={toc:l};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".VerifyTokenFetchStrategy"),(0,n.kt)("p",null,"The Verify Token strategy is used to verify tokens issued by the\nheadless wp plugin"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"VerifyTokenFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new VerifyTokenFetchStrategy"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L115"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:115")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L105"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:105")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L110"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:110")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Builds the final endpoint URL based on the passed parameters"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"},(0,n.kt)("inlineCode",{parentName:"a"},"VerifyTokenParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to add to the request")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The endpoint URL."),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts#L32"},"packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:32")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">",">"),(0,n.kt)("p",null,"The default fetcher function"),(0,n.kt)("p",null,"The default fetcher function handles authentication headers and errors from the API."),(0,n.kt)("p",null,"A custom strategy can override this function to run additional logic before or after the fetch call"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"},(0,n.kt)("inlineCode",{parentName:"a"},"VerifyTokenParams"))),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetcher options")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">",">"),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts#L39"},"packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:39")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L339"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:339")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">",">"),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L404"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:404")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L227"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:227")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L369"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:369")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts#L23"},"packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:23")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L168"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:168")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"overrides-3"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts#L28"},"packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:28")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L327"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L191"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:191")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L379"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:379")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L219"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:219")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L150"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:150")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L146"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:146")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a1514d7c.53eb0878.js b/assets/js/a1514d7c.6d9dc475.js similarity index 92% rename from assets/js/a1514d7c.53eb0878.js rename to assets/js/a1514d7c.6d9dc475.js index 6ab122acf..2175d6ca0 100644 --- a/assets/js/a1514d7c.53eb0878.js +++ b/assets/js/a1514d7c.6d9dc475.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2726],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.IMediaTextBlock",title:"Interface: IMediaTextBlock",sidebar_label:"@headstartwp/core.react.IMediaTextBlock",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IMediaTextBlock",id:"interfaces/headstartwp_core.react.IMediaTextBlock",title:"Interface: IMediaTextBlock",description:"@headstartwp/core.react.IMediaTextBlock",source:"@site/docs/interfaces/headstartwp_core.react.IMediaTextBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IMediaTextBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IMediaTextBlock",title:"Interface: IMediaTextBlock",sidebar_label:"@headstartwp/core.react.IMediaTextBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IListBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IListBlock"},next:{title:"@headstartwp/core.react.IParagraphBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IMediaTextBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"MediaTextBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IMediaTextBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"MediaTextBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"MediaTextBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2726],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),d=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),s=d(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},c),{},{components:a})):r.createElement(h,l({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.IMediaTextBlock",title:"Interface: IMediaTextBlock",sidebar_label:"@headstartwp/core.react.IMediaTextBlock",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IMediaTextBlock",id:"interfaces/headstartwp_core.react.IMediaTextBlock",title:"Interface: IMediaTextBlock",description:"@headstartwp/core.react.IMediaTextBlock",source:"@site/docs/interfaces/headstartwp_core.react.IMediaTextBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IMediaTextBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IMediaTextBlock",title:"Interface: IMediaTextBlock",sidebar_label:"@headstartwp/core.react.IMediaTextBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IListBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IListBlock"},next:{title:"@headstartwp/core.react.IParagraphBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IMediaTextBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"MediaTextBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IMediaTextBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"MediaTextBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"MediaTextBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a222760f.b2a1f870.js b/assets/js/a222760f.b0496467.js similarity index 99% rename from assets/js/a222760f.b2a1f870.js rename to assets/js/a222760f.b0496467.js index fcdaa22ea..ee4cf4f91 100644 --- a/assets/js/a222760f.b2a1f870.js +++ b/assets/js/a222760f.b0496467.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4637],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var d=n.createContext({}),p=function(e){var t=n.useContext(d),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return n.createElement(d.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),c=p(r),u=a,m=c["".concat(d,".").concat(u)]||c[u]||k[u]||i;return r?n.createElement(m,l(l({ref:t},s),{},{components:r})):n.createElement(m,l({ref:t},s))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=u;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o[c]="string"==typeof e?e:a,l[1]=o;for(var p=2;p{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const i={id:"headstartwp_core.NotFoundError",title:"Class: NotFoundError",sidebar_label:"@headstartwp/core.NotFoundError",custom_edit_url:null},l=void 0,o={unversionedId:"classes/headstartwp_core.NotFoundError",id:"classes/headstartwp_core.NotFoundError",title:"Class: NotFoundError",description:"@headstartwp/core.NotFoundError",source:"@site/docs/classes/headstartwp_core.NotFoundError.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.NotFoundError",permalink:"/docs/api/classes/headstartwp_core.NotFoundError",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.NotFoundError",title:"Class: NotFoundError",sidebar_label:"@headstartwp/core.NotFoundError",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.FrameworkError",permalink:"/docs/api/classes/headstartwp_core.FrameworkError"},next:{title:"@headstartwp/core.PostOrPostsFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"cause",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"stack",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"prepareStackTrace",id:"preparestacktrace",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:p};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".NotFoundError"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"Error")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"NotFoundError"))))),(0,a.kt)("h2",{id:"constructors"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new NotFoundError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"message"),")"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"Error.constructor"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/errors.ts#L4"},"packages/core/src/utils/errors.ts:4")),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"cause"},"cause"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"cause"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"Error.cause"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"message"},"message"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"message"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"Error.message"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1054"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"Error.name"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1053"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stack"},"stack"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"stack"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"Error.stack"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1055"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:127"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"preparestacktrace"},"prepareStackTrace"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"prepareStackTrace"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"CallSite"),"[]) => ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("p",null,"Optional override for formatting stack traces"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"See"))),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces"},"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces")),(0,a.kt)("h5",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"err")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Error"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"stackTraces")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"CallSite"),"[]")))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"Error.prepareStackTrace"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:140"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stacktracelimit"},"stackTraceLimit"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"stackTraceLimit"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"Error.stackTraceLimit"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:142"),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"capturestacktrace"},"captureStackTrace"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"captureStackTrace"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"targetObject"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"constructorOpt?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"Create .stack property on a target object"),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"targetObject")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Object"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"constructorOpt?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Function"))))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,"Error.captureStackTrace"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:133"))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4637],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var d=n.createContext({}),p=function(e){var t=n.useContext(d),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return n.createElement(d.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),c=p(r),u=a,m=c["".concat(d,".").concat(u)]||c[u]||k[u]||i;return r?n.createElement(m,l(l({ref:t},s),{},{components:r})):n.createElement(m,l({ref:t},s))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=u;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o[c]="string"==typeof e?e:a,l[1]=o;for(var p=2;p{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const i={id:"headstartwp_core.NotFoundError",title:"Class: NotFoundError",sidebar_label:"@headstartwp/core.NotFoundError",custom_edit_url:null},l=void 0,o={unversionedId:"classes/headstartwp_core.NotFoundError",id:"classes/headstartwp_core.NotFoundError",title:"Class: NotFoundError",description:"@headstartwp/core.NotFoundError",source:"@site/docs/classes/headstartwp_core.NotFoundError.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.NotFoundError",permalink:"/docs/api/classes/headstartwp_core.NotFoundError",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.NotFoundError",title:"Class: NotFoundError",sidebar_label:"@headstartwp/core.NotFoundError",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.FrameworkError",permalink:"/docs/api/classes/headstartwp_core.FrameworkError"},next:{title:"@headstartwp/core.PostOrPostsFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"cause",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"stack",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"prepareStackTrace",id:"preparestacktrace",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:p};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".NotFoundError"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"Error")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"NotFoundError"))))),(0,a.kt)("h2",{id:"constructors"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new NotFoundError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"message"),")"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"Error.constructor"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/errors.ts#L4"},"packages/core/src/utils/errors.ts:4")),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"cause"},"cause"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"cause"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"Error.cause"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"message"},"message"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"message"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"Error.message"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1054"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"Error.name"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1053"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stack"},"stack"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"stack"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"Error.stack"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1055"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:127"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"preparestacktrace"},"prepareStackTrace"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"prepareStackTrace"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"CallSite"),"[]) => ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("p",null,"Optional override for formatting stack traces"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"See"))),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces"},"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces")),(0,a.kt)("h5",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"err")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Error"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"stackTraces")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"CallSite"),"[]")))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"Error.prepareStackTrace"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:140"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stacktracelimit"},"stackTraceLimit"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"stackTraceLimit"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"Error.stackTraceLimit"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:142"),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"capturestacktrace"},"captureStackTrace"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"captureStackTrace"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"targetObject"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"constructorOpt?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"Create .stack property on a target object"),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"targetObject")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Object"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"constructorOpt?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Function"))))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,"Error.captureStackTrace"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:133"))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a304918f.804be197.js b/assets/js/a304918f.5be855cd.js similarity index 92% rename from assets/js/a304918f.804be197.js rename to assets/js/a304918f.5be855cd.js index 0bffd1a5a..cfd04a702 100644 --- a/assets/js/a304918f.804be197.js +++ b/assets/js/a304918f.5be855cd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1075],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var s=n.createContext({}),d=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),c=d(a),h=r,k=c["".concat(s,".").concat(h)]||c[h]||u[h]||i;return a?n.createElement(k,p(p({ref:t},o),{},{components:a})):n.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=h;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[c]="string"==typeof e?e:r,p[1]=l;for(var d=2;d{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.CommentEntity",title:"Interface: CommentEntity",sidebar_label:"@headstartwp/core.CommentEntity",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.CommentEntity",id:"interfaces/headstartwp_core.CommentEntity",title:"Interface: CommentEntity",description:"@headstartwp/core.CommentEntity",source:"@site/docs/interfaces/headstartwp_core.CommentEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.CommentEntity",permalink:"/docs/api/interfaces/headstartwp_core.CommentEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.CommentEntity",title:"Interface: CommentEntity",sidebar_label:"@headstartwp/core.CommentEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AvatarUrls",permalink:"/docs/api/interfaces/headstartwp_core.AvatarUrls"},next:{title:"@headstartwp/core.EndpointParams",permalink:"/docs/api/interfaces/headstartwp_core.EndpointParams"}},s={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"author",id:"author",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"author_avatar_urls",id:"author_avatar_urls",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"author_email",id:"author_email",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"author_name",id:"author_name",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"author_url",id:"author_url",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"content",id:"content",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"date",id:"date",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"link",id:"link",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"parent",id:"parent",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"post",id:"post",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-16",level:4}],o={toc:d};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".CommentEntity"),(0,r.kt)("p",null,"Interface for entities from the /wp/v2/comments endpoint."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"CommentEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"author"},"author"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"author"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The ID of the user object, if author was a user."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L563"},"packages/core/src/data/types/entities.ts:563")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author_avatar_urls"},"author","_","avatar","_","urls"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"author","_","avatar","_","urls"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AvatarUrls"},(0,r.kt)("inlineCode",{parentName:"a"},"AvatarUrls"))),(0,r.kt)("p",null,"Avatar URLs for the object author."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L623"},"packages/core/src/data/types/entities.ts:623")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author_email"},"author","_","email"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"author","_","email"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Email address for the object author."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L568"},"packages/core/src/data/types/entities.ts:568")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author_name"},"author","_","name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"author","_","name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Display name for the object author."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L573"},"packages/core/src/data/types/entities.ts:573")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author_url"},"author","_","url"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"author","_","url"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"URL for the object author."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L578"},"packages/core/src/data/types/entities.ts:578")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"content"},"content"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"content"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,r.kt)("p",null,"The content for the object."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L583"},"packages/core/src/data/types/entities.ts:583")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"date"},"date"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"date"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The date the object was published, in the site's timezone."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L588"},"packages/core/src/data/types/entities.ts:588")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The date the object was published, as GMT."),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L593"},"packages/core/src/data/types/entities.ts:593")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"id"},"id"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Unique identifier for the object."),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L558"},"packages/core/src/data/types/entities.ts:558")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"link"},"link"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"link"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"URL to the object."),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L598"},"packages/core/src/data/types/entities.ts:598")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,r.kt)("p",null,"Meta fields."),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L628"},"packages/core/src/data/types/entities.ts:628")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parent"},"parent"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"parent"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The ID for the parent of the object."),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L603"},"packages/core/src/data/types/entities.ts:603")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"post"},"post"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"post"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The ID of the associated post object."),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L608"},"packages/core/src/data/types/entities.ts:608")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"status"},"status"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"State of the object."),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L613"},"packages/core/src/data/types/entities.ts:613")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"type"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"comment"')),(0,r.kt)("p",null,"Type of Comment for the object."),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L618"},"packages/core/src/data/types/entities.ts:618")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1075],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var s=n.createContext({}),d=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),c=d(a),h=r,k=c["".concat(s,".").concat(h)]||c[h]||u[h]||i;return a?n.createElement(k,p(p({ref:t},o),{},{components:a})):n.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=h;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[c]="string"==typeof e?e:r,p[1]=l;for(var d=2;d{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.CommentEntity",title:"Interface: CommentEntity",sidebar_label:"@headstartwp/core.CommentEntity",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.CommentEntity",id:"interfaces/headstartwp_core.CommentEntity",title:"Interface: CommentEntity",description:"@headstartwp/core.CommentEntity",source:"@site/docs/interfaces/headstartwp_core.CommentEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.CommentEntity",permalink:"/docs/api/interfaces/headstartwp_core.CommentEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.CommentEntity",title:"Interface: CommentEntity",sidebar_label:"@headstartwp/core.CommentEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AvatarUrls",permalink:"/docs/api/interfaces/headstartwp_core.AvatarUrls"},next:{title:"@headstartwp/core.EndpointParams",permalink:"/docs/api/interfaces/headstartwp_core.EndpointParams"}},s={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"author",id:"author",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"author_avatar_urls",id:"author_avatar_urls",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"author_email",id:"author_email",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"author_name",id:"author_name",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"author_url",id:"author_url",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"content",id:"content",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"date",id:"date",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"link",id:"link",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"parent",id:"parent",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"post",id:"post",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-16",level:4}],o={toc:d};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".CommentEntity"),(0,r.kt)("p",null,"Interface for entities from the /wp/v2/comments endpoint."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"CommentEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"author"},"author"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"author"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The ID of the user object, if author was a user."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L563"},"packages/core/src/data/types/entities.ts:563")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author_avatar_urls"},"author","_","avatar","_","urls"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"author","_","avatar","_","urls"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AvatarUrls"},(0,r.kt)("inlineCode",{parentName:"a"},"AvatarUrls"))),(0,r.kt)("p",null,"Avatar URLs for the object author."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L623"},"packages/core/src/data/types/entities.ts:623")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author_email"},"author","_","email"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"author","_","email"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Email address for the object author."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L568"},"packages/core/src/data/types/entities.ts:568")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author_name"},"author","_","name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"author","_","name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Display name for the object author."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L573"},"packages/core/src/data/types/entities.ts:573")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author_url"},"author","_","url"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"author","_","url"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"URL for the object author."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L578"},"packages/core/src/data/types/entities.ts:578")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"content"},"content"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"content"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,r.kt)("p",null,"The content for the object."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L583"},"packages/core/src/data/types/entities.ts:583")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"date"},"date"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"date"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The date the object was published, in the site's timezone."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L588"},"packages/core/src/data/types/entities.ts:588")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The date the object was published, as GMT."),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L593"},"packages/core/src/data/types/entities.ts:593")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"id"},"id"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Unique identifier for the object."),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L558"},"packages/core/src/data/types/entities.ts:558")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"link"},"link"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"link"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"URL to the object."),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L598"},"packages/core/src/data/types/entities.ts:598")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,r.kt)("p",null,"Meta fields."),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L628"},"packages/core/src/data/types/entities.ts:628")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parent"},"parent"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"parent"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The ID for the parent of the object."),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L603"},"packages/core/src/data/types/entities.ts:603")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"post"},"post"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"post"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The ID of the associated post object."),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L608"},"packages/core/src/data/types/entities.ts:608")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"status"},"status"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"State of the object."),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L613"},"packages/core/src/data/types/entities.ts:613")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"type"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"comment"')),(0,r.kt)("p",null,"Type of Comment for the object."),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L618"},"packages/core/src/data/types/entities.ts:618")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a3f5e611.0bad5a08.js b/assets/js/a3f5e611.a30addf5.js similarity index 94% rename from assets/js/a3f5e611.0bad5a08.js rename to assets/js/a3f5e611.a30addf5.js index 892518f0c..2b72f1061 100644 --- a/assets/js/a3f5e611.0bad5a08.js +++ b/assets/js/a3f5e611.a30addf5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4222],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var c=a.createContext({}),p=function(e){var t=a.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return a.createElement(c.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,c=e.parentName,s=i(e,["components","mdxType","originalType","parentName"]),d=p(r),u=n,h=d["".concat(c,".").concat(u)]||d[u]||k[u]||o;return r?a.createElement(h,l(l({ref:t},s),{},{components:r})):a.createElement(h,l({ref:t},s))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,l=new Array(o);l[0]=u;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[d]="string"==typeof e?e:n,l[1]=i;for(var p=2;p{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.BlockAttributes",title:"Interface: BlockAttributes",sidebar_label:"@headstartwp/core.react.BlockAttributes",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.BlockAttributes",id:"interfaces/headstartwp_core.react.BlockAttributes",title:"Interface: BlockAttributes",description:"@headstartwp/core.react.BlockAttributes",source:"@site/docs/interfaces/headstartwp_core.react.BlockAttributes.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.BlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockAttributes",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.BlockAttributes",title:"Interface: BlockAttributes",sidebar_label:"@headstartwp/core.react.BlockAttributes",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.AudioBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},next:{title:"@headstartwp/core.react.BlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockProps"}},c={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"align",id:"align",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"backgroundColor",id:"backgroundcolor",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"backgroundColorSlug",id:"backgroundcolorslug",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"gradient",id:"gradient",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"gradientSlug",id:"gradientslug",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"linkColor",id:"linkcolor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"linkColorSlug",id:"linkcolorslug",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"textColor",id:"textcolor",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"textColorSlug",id:"textcolorslug",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"typography",id:"typography",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"width",id:"width",level:3},{value:"Defined in",id:"defined-in-11",level:4}],s={toc:p};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".BlockAttributes"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"BlockAttributes"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"align"},"align"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"align"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align"))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L95"},"packages/core/src/react/blocks/types.ts:95")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"backgroundcolor"},"backgroundColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"backgroundColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#backgroundcolor"},"backgroundColor")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L6"},"packages/core/src/react/blocks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"backgroundcolorslug"},"backgroundColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"backgroundColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#backgroundcolorslug"},"backgroundColorSlug")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L5"},"packages/core/src/react/blocks/types.ts:5")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"gradient"},"gradient"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"gradient"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#gradient"},"gradient")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L8"},"packages/core/src/react/blocks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"gradientslug"},"gradientSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"gradientSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#gradientslug"},"gradientSlug")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L7"},"packages/core/src/react/blocks/types.ts:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linkcolor"},"linkColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"linkColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#linkcolor"},"linkColor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L12"},"packages/core/src/react/blocks/types.ts:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linkcolorslug"},"linkColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"linkColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#linkcolorslug"},"linkColorSlug")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L11"},"packages/core/src/react/blocks/types.ts:11")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#style"},(0,n.kt)("inlineCode",{parentName:"a"},"Style")),">"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L96"},"packages/core/src/react/blocks/types.ts:96")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"textcolor"},"textColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"textColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#textcolor"},"textColor")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L10"},"packages/core/src/react/blocks/types.ts:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"textcolorslug"},"textColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"textColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#textcolorslug"},"textColorSlug")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L9"},"packages/core/src/react/blocks/types.ts:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"typography"},"typography"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"typography"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography"))),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L98"},"packages/core/src/react/blocks/types.ts:98")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"width"},"width"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"width"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L97"},"packages/core/src/react/blocks/types.ts:97")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4222],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var c=a.createContext({}),p=function(e){var t=a.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return a.createElement(c.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,c=e.parentName,s=i(e,["components","mdxType","originalType","parentName"]),d=p(r),u=n,h=d["".concat(c,".").concat(u)]||d[u]||k[u]||o;return r?a.createElement(h,l(l({ref:t},s),{},{components:r})):a.createElement(h,l({ref:t},s))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,l=new Array(o);l[0]=u;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[d]="string"==typeof e?e:n,l[1]=i;for(var p=2;p{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.BlockAttributes",title:"Interface: BlockAttributes",sidebar_label:"@headstartwp/core.react.BlockAttributes",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.BlockAttributes",id:"interfaces/headstartwp_core.react.BlockAttributes",title:"Interface: BlockAttributes",description:"@headstartwp/core.react.BlockAttributes",source:"@site/docs/interfaces/headstartwp_core.react.BlockAttributes.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.BlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockAttributes",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.BlockAttributes",title:"Interface: BlockAttributes",sidebar_label:"@headstartwp/core.react.BlockAttributes",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.AudioBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},next:{title:"@headstartwp/core.react.BlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockProps"}},c={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"align",id:"align",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"backgroundColor",id:"backgroundcolor",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"backgroundColorSlug",id:"backgroundcolorslug",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"gradient",id:"gradient",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"gradientSlug",id:"gradientslug",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"linkColor",id:"linkcolor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"linkColorSlug",id:"linkcolorslug",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"textColor",id:"textcolor",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"textColorSlug",id:"textcolorslug",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"typography",id:"typography",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"width",id:"width",level:3},{value:"Defined in",id:"defined-in-11",level:4}],s={toc:p};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".BlockAttributes"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"BlockAttributes"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"align"},"align"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"align"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align"))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L95"},"packages/core/src/react/blocks/types.ts:95")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"backgroundcolor"},"backgroundColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"backgroundColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#backgroundcolor"},"backgroundColor")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L6"},"packages/core/src/react/blocks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"backgroundcolorslug"},"backgroundColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"backgroundColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#backgroundcolorslug"},"backgroundColorSlug")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L5"},"packages/core/src/react/blocks/types.ts:5")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"gradient"},"gradient"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"gradient"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#gradient"},"gradient")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L8"},"packages/core/src/react/blocks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"gradientslug"},"gradientSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"gradientSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#gradientslug"},"gradientSlug")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L7"},"packages/core/src/react/blocks/types.ts:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linkcolor"},"linkColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"linkColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#linkcolor"},"linkColor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L12"},"packages/core/src/react/blocks/types.ts:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linkcolorslug"},"linkColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"linkColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#linkcolorslug"},"linkColorSlug")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L11"},"packages/core/src/react/blocks/types.ts:11")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#style"},(0,n.kt)("inlineCode",{parentName:"a"},"Style")),">"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L96"},"packages/core/src/react/blocks/types.ts:96")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"textcolor"},"textColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"textColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#textcolor"},"textColor")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L10"},"packages/core/src/react/blocks/types.ts:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"textcolorslug"},"textColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"textColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#textcolorslug"},"textColorSlug")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L9"},"packages/core/src/react/blocks/types.ts:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"typography"},"typography"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"typography"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography"))),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L98"},"packages/core/src/react/blocks/types.ts:98")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"width"},"width"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"width"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L97"},"packages/core/src/react/blocks/types.ts:97")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a40ccb42.417a4f9b.js b/assets/js/a40ccb42.0ae62e0d.js similarity index 97% rename from assets/js/a40ccb42.417a4f9b.js rename to assets/js/a40ccb42.0ae62e0d.js index 13e0f5aae..d4df3c414 100644 --- a/assets/js/a40ccb42.417a4f9b.js +++ b/assets/js/a40ccb42.0ae62e0d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8081],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),k=n,h=s["".concat(p,".").concat(k)]||s[k]||m[k]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=k;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.IImageBlock",title:"Interface: IImageBlock",sidebar_label:"@headstartwp/core.react.IImageBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IImageBlock",id:"interfaces/headstartwp_core.react.IImageBlock",title:"Interface: IImageBlock",description:"@headstartwp/core.react.IImageBlock",source:"@site/docs/interfaces/headstartwp_core.react.IImageBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IImageBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IImageBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IImageBlock",title:"Interface: IImageBlock",sidebar_label:"@headstartwp/core.react.IImageBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IHeadingBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock"},next:{title:"@headstartwp/core.react.IListBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IListBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IImageBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ImageBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IImageBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ImageBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ImageBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8081],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),k=n,h=s["".concat(p,".").concat(k)]||s[k]||m[k]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=k;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.IImageBlock",title:"Interface: IImageBlock",sidebar_label:"@headstartwp/core.react.IImageBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IImageBlock",id:"interfaces/headstartwp_core.react.IImageBlock",title:"Interface: IImageBlock",description:"@headstartwp/core.react.IImageBlock",source:"@site/docs/interfaces/headstartwp_core.react.IImageBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IImageBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IImageBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IImageBlock",title:"Interface: IImageBlock",sidebar_label:"@headstartwp/core.react.IImageBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IHeadingBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock"},next:{title:"@headstartwp/core.react.IListBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IListBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IImageBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ImageBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IImageBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ImageBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ImageBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a4f5c2b9.de1d9f66.js b/assets/js/a4f5c2b9.8aff1c6a.js similarity index 85% rename from assets/js/a4f5c2b9.de1d9f66.js rename to assets/js/a4f5c2b9.8aff1c6a.js index e86cc58cd..1680fb349 100644 --- a/assets/js/a4f5c2b9.de1d9f66.js +++ b/assets/js/a4f5c2b9.8aff1c6a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[607],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>f});var i=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function p(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=i.createContext({}),d=function(e){var t=i.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},c=function(e){var t=d(e.components);return i.createElement(s.Provider,{value:t},e.children)},o="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},k=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,r=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),o=d(n),k=a,f=o["".concat(s,".").concat(k)]||o[k]||u[k]||r;return n?i.createElement(f,p(p({ref:t},c),{},{components:n})):i.createElement(f,p({ref:t},c))}));function f(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,p=new Array(r);p[0]=k;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[o]="string"==typeof e?e:a,p[1]=l;for(var d=2;d{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>o,frontMatter:()=>r,metadata:()=>l,toc:()=>d});var i=n(7462),a=(n(7294),n(3905));const r={id:"headstartwp_core.MenuItemEntity",title:"Interface: MenuItemEntity",sidebar_label:"@headstartwp/core.MenuItemEntity",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.MenuItemEntity",id:"interfaces/headstartwp_core.MenuItemEntity",title:"Interface: MenuItemEntity",description:"@headstartwp/core.MenuItemEntity",source:"@site/docs/interfaces/headstartwp_core.MenuItemEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.MenuItemEntity",permalink:"/docs/api/interfaces/headstartwp_core.MenuItemEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.MenuItemEntity",title:"Interface: MenuItemEntity",sidebar_label:"@headstartwp/core.MenuItemEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Integration",permalink:"/docs/api/interfaces/headstartwp_core.Integration"},next:{title:"@headstartwp/core.PageEntity",permalink:"/docs/api/interfaces/headstartwp_core.PageEntity"}},s={},d=[{value:"Properties",id:"properties",level:2},{value:"ID",id:"id",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"attr_title",id:"attr_title",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"classes",id:"classes",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"menu_item_parent",id:"menu_item_parent",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"menu_order",id:"menu_order",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"object",id:"object",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"object_id",id:"object_id",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"order",id:"order",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"post_mime_type",id:"post_mime_type",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"post_type",id:"post_type",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"target",id:"target",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"type_label",id:"type_label",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-17",level:4}],c={toc:d};function o(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,i.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".MenuItemEntity"),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"id"},"ID"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"ID"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L657"},"packages/core/src/data/types/entities.ts:657")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"attr_title"},"attr","_","title"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"attr","_","title"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L669"},"packages/core/src/data/types/entities.ts:669")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"children"},"children"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"children"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},(0,a.kt)("inlineCode",{parentName:"a"},"MenuItemEntity")),"[]"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L673"},"packages/core/src/data/types/entities.ts:673")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"classes"},"classes"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"classes"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L671"},"packages/core/src/data/types/entities.ts:671")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L670"},"packages/core/src/data/types/entities.ts:670")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"menu_item_parent"},"menu","_","item","_","parent"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"menu","_","item","_","parent"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L661"},"packages/core/src/data/types/entities.ts:661")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"menu_order"},"menu","_","order"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"menu","_","order"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L658"},"packages/core/src/data/types/entities.ts:658")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"object"},"object"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"object"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L663"},"packages/core/src/data/types/entities.ts:663")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"object_id"},"object","_","id"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"object","_","id"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L662"},"packages/core/src/data/types/entities.ts:662")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"order"},"order"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"order"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L674"},"packages/core/src/data/types/entities.ts:674")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"post_mime_type"},"post","_","mime","_","type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"post","_","mime","_","type"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L660"},"packages/core/src/data/types/entities.ts:660")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"post_type"},"post","_","type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"post","_","type"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L659"},"packages/core/src/data/types/entities.ts:659")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"slug"},"slug"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"slug"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L672"},"packages/core/src/data/types/entities.ts:672")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"target"},"target"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"target"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"_blank"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"_self"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"_parent"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"_top"')),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L668"},"packages/core/src/data/types/entities.ts:668")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"title"},"title"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"title"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L667"},"packages/core/src/data/types/entities.ts:667")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L664"},"packages/core/src/data/types/entities.ts:664")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type_label"},"type","_","label"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"type","_","label"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L665"},"packages/core/src/data/types/entities.ts:665")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"url"},"url"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"url"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L666"},"packages/core/src/data/types/entities.ts:666")))}o.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[607],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>h});var i=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function p(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=i.createContext({}),d=function(e){var t=i.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},o=function(e){var t=d(e.components);return i.createElement(s.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},k=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,r=e.originalType,s=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),c=d(n),k=a,h=c["".concat(s,".").concat(k)]||c[k]||u[k]||r;return n?i.createElement(h,p(p({ref:t},o),{},{components:n})):i.createElement(h,p({ref:t},o))}));function h(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,p=new Array(r);p[0]=k;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[c]="string"==typeof e?e:a,p[1]=l;for(var d=2;d{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>r,metadata:()=>l,toc:()=>d});var i=n(7462),a=(n(7294),n(3905));const r={id:"headstartwp_core.MenuItemEntity",title:"Interface: MenuItemEntity",sidebar_label:"@headstartwp/core.MenuItemEntity",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.MenuItemEntity",id:"interfaces/headstartwp_core.MenuItemEntity",title:"Interface: MenuItemEntity",description:"@headstartwp/core.MenuItemEntity",source:"@site/docs/interfaces/headstartwp_core.MenuItemEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.MenuItemEntity",permalink:"/docs/api/interfaces/headstartwp_core.MenuItemEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.MenuItemEntity",title:"Interface: MenuItemEntity",sidebar_label:"@headstartwp/core.MenuItemEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Integration",permalink:"/docs/api/interfaces/headstartwp_core.Integration"},next:{title:"@headstartwp/core.PageEntity",permalink:"/docs/api/interfaces/headstartwp_core.PageEntity"}},s={},d=[{value:"Properties",id:"properties",level:2},{value:"ID",id:"id",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"attr_title",id:"attr_title",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"classes",id:"classes",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"menu_item_parent",id:"menu_item_parent",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"menu_order",id:"menu_order",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"object",id:"object",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"object_id",id:"object_id",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"order",id:"order",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"post_mime_type",id:"post_mime_type",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"post_type",id:"post_type",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"target",id:"target",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"type_label",id:"type_label",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-17",level:4}],o={toc:d};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,i.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".MenuItemEntity"),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"id"},"ID"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"ID"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L657"},"packages/core/src/data/types/entities.ts:657")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"attr_title"},"attr","_","title"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"attr","_","title"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L669"},"packages/core/src/data/types/entities.ts:669")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"children"},"children"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"children"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},(0,a.kt)("inlineCode",{parentName:"a"},"MenuItemEntity")),"[]"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L673"},"packages/core/src/data/types/entities.ts:673")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"classes"},"classes"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"classes"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L671"},"packages/core/src/data/types/entities.ts:671")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L670"},"packages/core/src/data/types/entities.ts:670")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"menu_item_parent"},"menu","_","item","_","parent"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"menu","_","item","_","parent"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L661"},"packages/core/src/data/types/entities.ts:661")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"menu_order"},"menu","_","order"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"menu","_","order"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L658"},"packages/core/src/data/types/entities.ts:658")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"object"},"object"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"object"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L663"},"packages/core/src/data/types/entities.ts:663")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"object_id"},"object","_","id"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"object","_","id"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L662"},"packages/core/src/data/types/entities.ts:662")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"order"},"order"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"order"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L674"},"packages/core/src/data/types/entities.ts:674")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"post_mime_type"},"post","_","mime","_","type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"post","_","mime","_","type"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L660"},"packages/core/src/data/types/entities.ts:660")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"post_type"},"post","_","type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"post","_","type"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L659"},"packages/core/src/data/types/entities.ts:659")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"slug"},"slug"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"slug"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L672"},"packages/core/src/data/types/entities.ts:672")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"target"},"target"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"target"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"_blank"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"_self"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"_parent"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"_top"')),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L668"},"packages/core/src/data/types/entities.ts:668")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"title"},"title"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"title"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L667"},"packages/core/src/data/types/entities.ts:667")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L664"},"packages/core/src/data/types/entities.ts:664")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type_label"},"type","_","label"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"type","_","label"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L665"},"packages/core/src/data/types/entities.ts:665")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"url"},"url"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"url"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L666"},"packages/core/src/data/types/entities.ts:666")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a56bba46.82d3b457.js b/assets/js/a56bba46.f146c7d9.js similarity index 85% rename from assets/js/a56bba46.82d3b457.js rename to assets/js/a56bba46.f146c7d9.js index e4ccba87a..b83932772 100644 --- a/assets/js/a56bba46.82d3b457.js +++ b/assets/js/a56bba46.f146c7d9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7148],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>u});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var l=n.createContext({}),s=function(e){var t=n.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},c=function(e){var t=s(e.components);return n.createElement(l.Provider,{value:t},e.children)},d="mdxType",f={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),d=s(a),h=r,u=d["".concat(l,".").concat(h)]||d[h]||f[h]||o;return a?n.createElement(u,i(i({ref:t},c),{},{components:a})):n.createElement(u,i({ref:t},c))}));function u(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=a.length,i=new Array(o);i[0]=h;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p[d]="string"==typeof e?e:r,i[1]=p;for(var s=2;s{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>p,toc:()=>s});var n=a(7462),r=(a(7294),a(3905));const o={id:"headstartwp_next.FetchHookDataOptions",title:"Interface: FetchHookDataOptions",sidebar_label:"@headstartwp/next.FetchHookDataOptions",custom_edit_url:null},i=void 0,p={unversionedId:"interfaces/headstartwp_next.FetchHookDataOptions",id:"interfaces/headstartwp_next.FetchHookDataOptions",title:"Interface: FetchHookDataOptions",description:"@headstartwp/next.FetchHookDataOptions",source:"@site/docs/interfaces/headstartwp_next.FetchHookDataOptions.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_next.FetchHookDataOptions",permalink:"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_next.FetchHookDataOptions",title:"Interface: FetchHookDataOptions",sidebar_label:"@headstartwp/next.FetchHookDataOptions",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.useTermsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"},next:{title:"@headstartwp/next.ImageProps",permalink:"/docs/api/interfaces/headstartwp_next.ImageProps"}},l={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"fetchStrategyOptions",id:"fetchstrategyoptions",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"params",id:"params",level:3},{value:"Defined in",id:"defined-in-2",level:4}],c={toc:s};function d(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next"},"@headstartwp/next"),".FetchHookDataOptions"),(0,r.kt)("p",null,"The supported options for ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#fetchhookdata"},"fetchHookData")),(0,r.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"unknown"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"unknown"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"fetchstrategyoptions"},"fetchStrategyOptions"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"fetchStrategyOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"FetchOptions")),(0,r.kt)("p",null,"Optional. If set, will forward fetch options to the fetch strategy"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/server/fetchHookData.ts#L34"},"packages/next/src/data/server/fetchHookData.ts:34")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"filterdata"},"filterData"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"filterData"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"FilterDataOptions"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"Optional. If set, the data will be filtered given FilterDataOptions"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/server/fetchHookData.ts#L29"},"packages/next/src/data/server/fetchHookData.ts:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"params"},"params"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"params"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"P")),(0,r.kt)("p",null,"This should match params passed to the hook on the client side."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/data/server/fetchHookData.ts#L24"},"packages/next/src/data/server/fetchHookData.ts:24")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7148],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>u});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var l=n.createContext({}),s=function(e){var t=n.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=s(e.components);return n.createElement(l.Provider,{value:t},e.children)},c="mdxType",f={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),c=s(a),h=r,u=c["".concat(l,".").concat(h)]||c[h]||f[h]||o;return a?n.createElement(u,i(i({ref:t},d),{},{components:a})):n.createElement(u,i({ref:t},d))}));function u(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=a.length,i=new Array(o);i[0]=h;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p[c]="string"==typeof e?e:r,i[1]=p;for(var s=2;s{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>c,frontMatter:()=>o,metadata:()=>p,toc:()=>s});var n=a(7462),r=(a(7294),a(3905));const o={id:"headstartwp_next.FetchHookDataOptions",title:"Interface: FetchHookDataOptions",sidebar_label:"@headstartwp/next.FetchHookDataOptions",custom_edit_url:null},i=void 0,p={unversionedId:"interfaces/headstartwp_next.FetchHookDataOptions",id:"interfaces/headstartwp_next.FetchHookDataOptions",title:"Interface: FetchHookDataOptions",description:"@headstartwp/next.FetchHookDataOptions",source:"@site/docs/interfaces/headstartwp_next.FetchHookDataOptions.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_next.FetchHookDataOptions",permalink:"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_next.FetchHookDataOptions",title:"Interface: FetchHookDataOptions",sidebar_label:"@headstartwp/next.FetchHookDataOptions",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.useTermsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"},next:{title:"@headstartwp/next.ImageProps",permalink:"/docs/api/interfaces/headstartwp_next.ImageProps"}},l={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"fetchStrategyOptions",id:"fetchstrategyoptions",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"params",id:"params",level:3},{value:"Defined in",id:"defined-in-2",level:4}],d={toc:s};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next"},"@headstartwp/next"),".FetchHookDataOptions"),(0,r.kt)("p",null,"The supported options for ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#fetchhookdata"},"fetchHookData")),(0,r.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"unknown"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"unknown"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"fetchstrategyoptions"},"fetchStrategyOptions"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"fetchStrategyOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"FetchOptions")),(0,r.kt)("p",null,"Optional. If set, will forward fetch options to the fetch strategy"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/server/fetchHookData.ts#L34"},"packages/next/src/data/server/fetchHookData.ts:34")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"filterdata"},"filterData"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"filterData"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"FilterDataOptions"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"Optional. If set, the data will be filtered given FilterDataOptions"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/server/fetchHookData.ts#L29"},"packages/next/src/data/server/fetchHookData.ts:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"params"},"params"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"params"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"P")),(0,r.kt)("p",null,"This should match params passed to the hook on the client side."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/data/server/fetchHookData.ts#L24"},"packages/next/src/data/server/fetchHookData.ts:24")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a56c2626.b57a3f20.js b/assets/js/a56c2626.0a2d71dc.js similarity index 98% rename from assets/js/a56c2626.b57a3f20.js rename to assets/js/a56c2626.0a2d71dc.js index 5e8375997..97c2df006 100644 --- a/assets/js/a56c2626.b57a3f20.js +++ b/assets/js/a56c2626.0a2d71dc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2973],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function c(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var i=n.createContext({}),p=function(e){var t=n.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):c(c({},t),e)),r},l=function(e){var t=p(e.components);return n.createElement(i.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,i=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),u=p(r),h=a,f=u["".concat(i,".").concat(h)]||u[h]||d[h]||o;return r?n.createElement(f,c(c({ref:t},l),{},{components:r})):n.createElement(f,c({ref:t},l))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,c=new Array(o);c[0]=h;var s={};for(var i in t)hasOwnProperty.call(t,i)&&(s[i]=t[i]);s.originalType=e,s[u]="string"==typeof e?e:a,c[1]=s;for(var p=2;p{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const o={id:"headstartwp_core.react.useFetchOptions",title:"Interface: useFetchOptions",sidebar_label:"@headstartwp/core.react.useFetchOptions",custom_edit_url:null},c=void 0,s={unversionedId:"interfaces/headstartwp_core.react.useFetchOptions",id:"interfaces/headstartwp_core.react.useFetchOptions",title:"Interface: useFetchOptions",description:"@headstartwp/core.react.useFetchOptions",source:"@site/docs/interfaces/headstartwp_core.react.useFetchOptions.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.useFetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.useFetchOptions",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.useFetchOptions",title:"Interface: useFetchOptions",sidebar_label:"@headstartwp/core.react.useFetchOptions",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.useAppSettingsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"},next:{title:"@headstartwp/core.react.useMenuResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"}},i={},p=[{value:"Properties",id:"properties",level:2},{value:"shouldFetch",id:"shouldfetch",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in",level:4}],l={toc:p};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".useFetchOptions"),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"shouldfetch"},"shouldFetch"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"shouldFetch"),": () => ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/useFetch.ts#L11"},"packages/core/src/react/hooks/useFetch.ts:11")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2973],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function c(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var i=n.createContext({}),p=function(e){var t=n.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):c(c({},t),e)),r},l=function(e){var t=p(e.components);return n.createElement(i.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,i=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),u=p(r),h=a,f=u["".concat(i,".").concat(h)]||u[h]||d[h]||o;return r?n.createElement(f,c(c({ref:t},l),{},{components:r})):n.createElement(f,c({ref:t},l))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,c=new Array(o);c[0]=h;var s={};for(var i in t)hasOwnProperty.call(t,i)&&(s[i]=t[i]);s.originalType=e,s[u]="string"==typeof e?e:a,c[1]=s;for(var p=2;p{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const o={id:"headstartwp_core.react.useFetchOptions",title:"Interface: useFetchOptions",sidebar_label:"@headstartwp/core.react.useFetchOptions",custom_edit_url:null},c=void 0,s={unversionedId:"interfaces/headstartwp_core.react.useFetchOptions",id:"interfaces/headstartwp_core.react.useFetchOptions",title:"Interface: useFetchOptions",description:"@headstartwp/core.react.useFetchOptions",source:"@site/docs/interfaces/headstartwp_core.react.useFetchOptions.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.useFetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.useFetchOptions",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.useFetchOptions",title:"Interface: useFetchOptions",sidebar_label:"@headstartwp/core.react.useFetchOptions",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.useAppSettingsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"},next:{title:"@headstartwp/core.react.useMenuResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"}},i={},p=[{value:"Properties",id:"properties",level:2},{value:"shouldFetch",id:"shouldfetch",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in",level:4}],l={toc:p};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".useFetchOptions"),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"shouldfetch"},"shouldFetch"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"shouldFetch"),": () => ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/useFetch.ts#L11"},"packages/core/src/react/hooks/useFetch.ts:11")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ac461116.13cb382d.js b/assets/js/ac461116.5cd6abbc.js similarity index 96% rename from assets/js/ac461116.13cb382d.js rename to assets/js/ac461116.5cd6abbc.js index 8342a2642..a26b75967 100644 --- a/assets/js/ac461116.13cb382d.js +++ b/assets/js/ac461116.5cd6abbc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3514],{3905:(e,t,r)=>{r.d(t,{Zo:()=>i,kt:()=>k});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function c(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),l=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},i=function(e){var t=l(e.components);return a.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},f=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,c=e.originalType,s=e.parentName,i=p(e,["components","mdxType","originalType","parentName"]),d=l(r),f=n,k=d["".concat(s,".").concat(f)]||d[f]||u[f]||c;return r?a.createElement(k,o(o({ref:t},i),{},{components:r})):a.createElement(k,o({ref:t},i))}));function k(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var c=r.length,o=new Array(c);o[0]=f;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[d]="string"==typeof e?e:n,o[1]=p;for(var l=2;l{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>d,frontMatter:()=>c,metadata:()=>p,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const c={id:"headstartwp_core.react.GutenbergBlockProps",title:"Interface: GutenbergBlockProps",sidebar_label:"@headstartwp/core.react.GutenbergBlockProps",custom_edit_url:null},o=void 0,p={unversionedId:"interfaces/headstartwp_core.react.GutenbergBlockProps",id:"interfaces/headstartwp_core.react.GutenbergBlockProps",title:"Interface: GutenbergBlockProps",description:"@headstartwp/core.react.GutenbergBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.GutenbergBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.GutenbergBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GutenbergBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.GutenbergBlockProps",title:"Interface: GutenbergBlockProps",sidebar_label:"@headstartwp/core.react.GutenbergBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.GroupBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},next:{title:"@headstartwp/core.react.HeadingBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"}},s={},l=[{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-2",level:4}],i={toc:l};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},i,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".GutenbergBlockProps"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L62"},"packages/core/src/react/blocks/types.ts:62")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L61"},"packages/core/src/react/blocks/types.ts:61")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L60"},"packages/core/src/react/blocks/types.ts:60")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3514],{3905:(e,t,r)=>{r.d(t,{Zo:()=>i,kt:()=>k});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function c(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),l=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},i=function(e){var t=l(e.components);return a.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},f=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,c=e.originalType,s=e.parentName,i=p(e,["components","mdxType","originalType","parentName"]),d=l(r),f=n,k=d["".concat(s,".").concat(f)]||d[f]||u[f]||c;return r?a.createElement(k,o(o({ref:t},i),{},{components:r})):a.createElement(k,o({ref:t},i))}));function k(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var c=r.length,o=new Array(c);o[0]=f;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[d]="string"==typeof e?e:n,o[1]=p;for(var l=2;l{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>d,frontMatter:()=>c,metadata:()=>p,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const c={id:"headstartwp_core.react.GutenbergBlockProps",title:"Interface: GutenbergBlockProps",sidebar_label:"@headstartwp/core.react.GutenbergBlockProps",custom_edit_url:null},o=void 0,p={unversionedId:"interfaces/headstartwp_core.react.GutenbergBlockProps",id:"interfaces/headstartwp_core.react.GutenbergBlockProps",title:"Interface: GutenbergBlockProps",description:"@headstartwp/core.react.GutenbergBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.GutenbergBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.GutenbergBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GutenbergBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.GutenbergBlockProps",title:"Interface: GutenbergBlockProps",sidebar_label:"@headstartwp/core.react.GutenbergBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.GroupBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},next:{title:"@headstartwp/core.react.HeadingBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"}},s={},l=[{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-2",level:4}],i={toc:l};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},i,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".GutenbergBlockProps"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L62"},"packages/core/src/react/blocks/types.ts:62")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L61"},"packages/core/src/react/blocks/types.ts:61")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L60"},"packages/core/src/react/blocks/types.ts:60")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ae778953.63597942.js b/assets/js/ae778953.1c9d1a65.js similarity index 97% rename from assets/js/ae778953.63597942.js rename to assets/js/ae778953.1c9d1a65.js index 6b0a54ccd..efa52fc2d 100644 --- a/assets/js/ae778953.63597942.js +++ b/assets/js/ae778953.1c9d1a65.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9726],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var c=a.createContext({}),l=function(e){var t=a.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},p=function(e){var t=l(e.components);return a.createElement(c.Provider,{value:t},e.children)},u="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,c=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),u=l(r),d=n,m=u["".concat(c,".").concat(d)]||u[d]||h[d]||o;return r?a.createElement(m,s(s({ref:t},p),{},{components:r})):a.createElement(m,s({ref:t},p))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=d;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[u]="string"==typeof e?e:n,s[1]=i;for(var l=2;l{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const o={slug:"/data-fetching/usesearch",sidebar_position:5},s="The useSearch hook",i={unversionedId:"Data Fetching/useSearch",id:"Data Fetching/useSearch",title:"The useSearch hook",description:"The useSearch hook is the Next.js binding for the useFetchSearch.",source:"@site/documentation/02 - Data Fetching/useSearch.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/usesearch",permalink:"/docs/learn/data-fetching/usesearch",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/useSearch.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:5,frontMatter:{slug:"/data-fetching/usesearch",sidebar_position:5},sidebar:"tutorialSidebar",previous:{title:"The useTerms hook",permalink:"/docs/learn/data-fetching/useterms"},next:{title:"The useSeo hook",permalink:"/docs/learn/data-fetching/useSeo"}},c={},l=[{value:"Basic Usage",id:"basic-usage",level:2},{value:"QueriedObject",id:"queriedobject",level:2},{value:"Known limitations",id:"known-limitations",level:2}],p={toc:l};function u(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("h1",{id:"the-usesearch-hook"},"The useSearch hook"),(0,n.kt)("blockquote",null,(0,n.kt)("p",{parentName:"blockquote"},"The ",(0,n.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#usesearch"},"useSearch")," hook is the Next.js binding for the ",(0,n.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchsearch"},"useFetchSearch"),".")),(0,n.kt)("p",null,"The ",(0,n.kt)("inlineCode",{parentName:"p"},"useSearch")," hook searches for WordPress posts from a registered post type."),(0,n.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,n.kt)("p",null,"Assuming a ",(0,n.kt)("inlineCode",{parentName:"p"},"src/pages/search/[[...path]].js")," route with the following content."),(0,n.kt)("admonition",{type:"info"},(0,n.kt)("p",{parentName:"admonition"},"This example is using the optional catch-all route ",(0,n.kt)("inlineCode",{parentName:"p"},"[[..path]].js")," because we want the ",(0,n.kt)("inlineCode",{parentName:"p"},"/search")," route to be handled by the same file and fetch the latest posts.")),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/search/[[...path]].js"',title:'"src/pages/search/[[...path]].js"'},"import { useSearch } from '@headstartwp/next';\n\nconst ArchivePage = () => {\n const { loading, error, data } = useSearch({ per_page: 10 });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n {data?.posts?.map((post) => (\n

{post.title.rendered}

\n ))}\n
\n );\n};\n")),(0,n.kt)("p",null,"The route will automatically render the latest 10 posts if no search term is provided. The following paths are automatically handled:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"/search/search-term"),(0,n.kt)("li",{parentName:"ul"},"/search/search-term/page/2"),(0,n.kt)("li",{parentName:"ul"},"/search")),(0,n.kt)("h2",{id:"queriedobject"},"QueriedObject"),(0,n.kt)("p",null,"The ",(0,n.kt)("inlineCode",{parentName:"p"},"useSearch")," hook also exposes a ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),". See ",(0,n.kt)("a",{parentName:"p",href:"/learn/data-fetching/useposts/#queried-object"},"usePosts docs")," for more info."),(0,n.kt)("p",null,"The queried object for for this hook is an object of type ",(0,n.kt)("a",{parentName:"p",href:"/api/interfaces/headstartwp_core.SearchEntity/"},"SearchEntity"),"."),(0,n.kt)("h2",{id:"known-limitations"},"Known limitations"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"It is not possible to fetch posts from more than one post type.")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9726],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var c=a.createContext({}),l=function(e){var t=a.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},p=function(e){var t=l(e.components);return a.createElement(c.Provider,{value:t},e.children)},u="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,c=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),u=l(r),d=n,m=u["".concat(c,".").concat(d)]||u[d]||h[d]||o;return r?a.createElement(m,s(s({ref:t},p),{},{components:r})):a.createElement(m,s({ref:t},p))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=d;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[u]="string"==typeof e?e:n,s[1]=i;for(var l=2;l{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const o={slug:"/data-fetching/usesearch",sidebar_position:5},s="The useSearch hook",i={unversionedId:"Data Fetching/useSearch",id:"Data Fetching/useSearch",title:"The useSearch hook",description:"The useSearch hook is the Next.js binding for the useFetchSearch.",source:"@site/documentation/02 - Data Fetching/useSearch.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/usesearch",permalink:"/docs/learn/data-fetching/usesearch",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/useSearch.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:5,frontMatter:{slug:"/data-fetching/usesearch",sidebar_position:5},sidebar:"tutorialSidebar",previous:{title:"The useTerms hook",permalink:"/docs/learn/data-fetching/useterms"},next:{title:"The useSeo hook",permalink:"/docs/learn/data-fetching/useSeo"}},c={},l=[{value:"Basic Usage",id:"basic-usage",level:2},{value:"QueriedObject",id:"queriedobject",level:2},{value:"Known limitations",id:"known-limitations",level:2}],p={toc:l};function u(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("h1",{id:"the-usesearch-hook"},"The useSearch hook"),(0,n.kt)("blockquote",null,(0,n.kt)("p",{parentName:"blockquote"},"The ",(0,n.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#usesearch"},"useSearch")," hook is the Next.js binding for the ",(0,n.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchsearch"},"useFetchSearch"),".")),(0,n.kt)("p",null,"The ",(0,n.kt)("inlineCode",{parentName:"p"},"useSearch")," hook searches for WordPress posts from a registered post type."),(0,n.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,n.kt)("p",null,"Assuming a ",(0,n.kt)("inlineCode",{parentName:"p"},"src/pages/search/[[...path]].js")," route with the following content."),(0,n.kt)("admonition",{type:"info"},(0,n.kt)("p",{parentName:"admonition"},"This example is using the optional catch-all route ",(0,n.kt)("inlineCode",{parentName:"p"},"[[..path]].js")," because we want the ",(0,n.kt)("inlineCode",{parentName:"p"},"/search")," route to be handled by the same file and fetch the latest posts.")),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/search/[[...path]].js"',title:'"src/pages/search/[[...path]].js"'},"import { useSearch } from '@headstartwp/next';\n\nconst ArchivePage = () => {\n const { loading, error, data } = useSearch({ per_page: 10 });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n {data?.posts?.map((post) => (\n

{post.title.rendered}

\n ))}\n
\n );\n};\n")),(0,n.kt)("p",null,"The route will automatically render the latest 10 posts if no search term is provided. The following paths are automatically handled:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"/search/search-term"),(0,n.kt)("li",{parentName:"ul"},"/search/search-term/page/2"),(0,n.kt)("li",{parentName:"ul"},"/search")),(0,n.kt)("h2",{id:"queriedobject"},"QueriedObject"),(0,n.kt)("p",null,"The ",(0,n.kt)("inlineCode",{parentName:"p"},"useSearch")," hook also exposes a ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),". See ",(0,n.kt)("a",{parentName:"p",href:"/learn/data-fetching/useposts/#queried-object"},"usePosts docs")," for more info."),(0,n.kt)("p",null,"The queried object for for this hook is an object of type ",(0,n.kt)("a",{parentName:"p",href:"/api/interfaces/headstartwp_core.SearchEntity/"},"SearchEntity"),"."),(0,n.kt)("h2",{id:"known-limitations"},"Known limitations"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"It is not possible to fetch posts from more than one post type.")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b29fd792.7cbff37d.js b/assets/js/b29fd792.a503b464.js similarity index 90% rename from assets/js/b29fd792.7cbff37d.js rename to assets/js/b29fd792.a503b464.js index fba7576de..a367cc39d 100644 --- a/assets/js/b29fd792.7cbff37d.js +++ b/assets/js/b29fd792.a503b464.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6048],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),c=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},s=function(e){var t=c(e.components);return r.createElement(o.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),d=c(a),m=n,h=d["".concat(o,".").concat(m)]||d[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},s),{},{components:a})):r.createElement(h,l({ref:t},s))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[d]="string"==typeof e?e:n,l[1]=p;for(var c=2;c{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>p,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.TableBlockProps",title:"Interface: TableBlockProps",sidebar_label:"@headstartwp/core.react.TableBlockProps",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.TableBlockProps",id:"interfaces/headstartwp_core.react.TableBlockProps",title:"Interface: TableBlockProps",description:"@headstartwp/core.react.TableBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.TableBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.TableBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.TableBlockProps",title:"Interface: TableBlockProps",sidebar_label:"@headstartwp/core.react.TableBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.StylesProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},next:{title:"@headstartwp/core.react.Typography",permalink:"/docs/api/interfaces/headstartwp_core.react.Typography"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"hasFixedLayout",id:"hasfixedlayout",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:c};function d(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".TableBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"TableBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"hasfixedlayout"},"hasFixedLayout"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"hasFixedLayout"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/TableBlock.tsx#L7"},"packages/core/src/react/blocks/TableBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6048],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),c=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(o,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[s]="string"==typeof e?e:n,l[1]=p;for(var c=2;c{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.TableBlockProps",title:"Interface: TableBlockProps",sidebar_label:"@headstartwp/core.react.TableBlockProps",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.TableBlockProps",id:"interfaces/headstartwp_core.react.TableBlockProps",title:"Interface: TableBlockProps",description:"@headstartwp/core.react.TableBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.TableBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.TableBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.TableBlockProps",title:"Interface: TableBlockProps",sidebar_label:"@headstartwp/core.react.TableBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.StylesProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},next:{title:"@headstartwp/core.react.Typography",permalink:"/docs/api/interfaces/headstartwp_core.react.Typography"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"hasFixedLayout",id:"hasfixedlayout",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".TableBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"TableBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"hasfixedlayout"},"hasFixedLayout"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"hasFixedLayout"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/TableBlock.tsx#L7"},"packages/core/src/react/blocks/TableBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b2b781c5.2ae54712.js b/assets/js/b2b781c5.772d2060.js similarity index 97% rename from assets/js/b2b781c5.2ae54712.js rename to assets/js/b2b781c5.772d2060.js index 87af1cb88..188a1cc33 100644 --- a/assets/js/b2b781c5.2ae54712.js +++ b/assets/js/b2b781c5.772d2060.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6563],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),c=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(o,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[s]="string"==typeof e?e:n,l[1]=p;for(var c=2;c{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.IBlock",title:"Interface: IBlock",sidebar_label:"@headstartwp/core.react.IBlock",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.IBlock",id:"interfaces/headstartwp_core.react.IBlock",title:"Interface: IBlock",description:"@headstartwp/core.react.IBlock",source:"@site/docs/interfaces/headstartwp_core.react.IBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IBlock",title:"Interface: IBlock",sidebar_label:"@headstartwp/core.react.IBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IAudioBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock"},next:{title:"@headstartwp/core.react.IBlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"}},o={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("inlineCode",{parentName:"p"},"Omit"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"BlockProps")),", ",(0,n.kt)("inlineCode",{parentName:"p"},'"test"'),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IButtonBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IButtonsBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IAudioBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"ICodeBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IColumnsBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IColumnBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ICoverBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"ICoverBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IParagraphBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IHeadingBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IQuoteBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IPullQuoteBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IPreformattedBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IVerseBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ITableBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"ITableBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IGroupBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"ISeparatorBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"ISpacerBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IListBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IListBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IYoutubeLiteBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IFileBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IFileBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IMediaTextBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IImageBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,"Omit.children"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,"Omit.classList"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,"Omit.domNode"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,"Omit.exclude"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,"Omit.style"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,"Omit.tagName"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6563],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),c=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(o,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[s]="string"==typeof e?e:n,l[1]=p;for(var c=2;c{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.IBlock",title:"Interface: IBlock",sidebar_label:"@headstartwp/core.react.IBlock",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.IBlock",id:"interfaces/headstartwp_core.react.IBlock",title:"Interface: IBlock",description:"@headstartwp/core.react.IBlock",source:"@site/docs/interfaces/headstartwp_core.react.IBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IBlock",title:"Interface: IBlock",sidebar_label:"@headstartwp/core.react.IBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IAudioBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock"},next:{title:"@headstartwp/core.react.IBlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"}},o={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("inlineCode",{parentName:"p"},"Omit"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"BlockProps")),", ",(0,n.kt)("inlineCode",{parentName:"p"},'"test"'),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IButtonBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IButtonsBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IAudioBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"ICodeBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IColumnsBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IColumnBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ICoverBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"ICoverBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IParagraphBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IHeadingBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IQuoteBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IPullQuoteBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IPreformattedBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IVerseBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ITableBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"ITableBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IGroupBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"ISeparatorBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"ISpacerBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IListBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IListBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IYoutubeLiteBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IFileBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IFileBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IMediaTextBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IImageBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,"Omit.children"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,"Omit.classList"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,"Omit.domNode"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,"Omit.exclude"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,"Omit.style"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,"Omit.tagName"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b2de5b9f.a082ff17.js b/assets/js/b2de5b9f.d3088901.js similarity index 86% rename from assets/js/b2de5b9f.a082ff17.js rename to assets/js/b2de5b9f.d3088901.js index d99757853..42de3f7cd 100644 --- a/assets/js/b2de5b9f.a082ff17.js +++ b/assets/js/b2de5b9f.d3088901.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9256],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>g});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var l=a.createContext({}),s=function(e){var t=a.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=s(e.components);return a.createElement(l.Provider,{value:t},e.children)},d="mdxType",f={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,l=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),d=s(r),u=n,g=d["".concat(l,".").concat(u)]||d[u]||f[u]||o;return r?a.createElement(g,i(i({ref:t},c),{},{components:r})):a.createElement(g,i({ref:t},c))}));function g(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,i=new Array(o);i[0]=u;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p[d]="string"==typeof e?e:n,i[1]=p;for(var s=2;s{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>p,toc:()=>s});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.PageInfo",title:"Interface: PageInfo",sidebar_label:"@headstartwp/core.PageInfo",custom_edit_url:null},i=void 0,p={unversionedId:"interfaces/headstartwp_core.PageInfo",id:"interfaces/headstartwp_core.PageInfo",title:"Interface: PageInfo",description:"@headstartwp/core.PageInfo",source:"@site/docs/interfaces/headstartwp_core.PageInfo.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PageInfo",permalink:"/docs/api/interfaces/headstartwp_core.PageInfo",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PageInfo",title:"Interface: PageInfo",sidebar_label:"@headstartwp/core.PageInfo",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PageEntity",permalink:"/docs/api/interfaces/headstartwp_core.PageEntity"},next:{title:"@headstartwp/core.PolylangIntegration",permalink:"/docs/api/interfaces/headstartwp_core.PolylangIntegration"}},l={},s=[{value:"Properties",id:"properties",level:2},{value:"page",id:"page",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"totalItems",id:"totalitems",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"totalPages",id:"totalpages",level:3},{value:"Defined in",id:"defined-in-2",level:4}],c={toc:s};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PageInfo"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"page"},"page"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"page"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L699"},"packages/core/src/data/types/entities.ts:699")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"totalitems"},"totalItems"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"totalItems"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L698"},"packages/core/src/data/types/entities.ts:698")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"totalpages"},"totalPages"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"totalPages"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L697"},"packages/core/src/data/types/entities.ts:697")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9256],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>g});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var l=a.createContext({}),s=function(e){var t=a.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=s(e.components);return a.createElement(l.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},f=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,l=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),d=s(r),f=n,g=d["".concat(l,".").concat(f)]||d[f]||u[f]||o;return r?a.createElement(g,i(i({ref:t},c),{},{components:r})):a.createElement(g,i({ref:t},c))}));function g(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,i=new Array(o);i[0]=f;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p[d]="string"==typeof e?e:n,i[1]=p;for(var s=2;s{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>p,toc:()=>s});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.PageInfo",title:"Interface: PageInfo",sidebar_label:"@headstartwp/core.PageInfo",custom_edit_url:null},i=void 0,p={unversionedId:"interfaces/headstartwp_core.PageInfo",id:"interfaces/headstartwp_core.PageInfo",title:"Interface: PageInfo",description:"@headstartwp/core.PageInfo",source:"@site/docs/interfaces/headstartwp_core.PageInfo.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PageInfo",permalink:"/docs/api/interfaces/headstartwp_core.PageInfo",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PageInfo",title:"Interface: PageInfo",sidebar_label:"@headstartwp/core.PageInfo",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PageEntity",permalink:"/docs/api/interfaces/headstartwp_core.PageEntity"},next:{title:"@headstartwp/core.PolylangIntegration",permalink:"/docs/api/interfaces/headstartwp_core.PolylangIntegration"}},l={},s=[{value:"Properties",id:"properties",level:2},{value:"page",id:"page",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"totalItems",id:"totalitems",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"totalPages",id:"totalpages",level:3},{value:"Defined in",id:"defined-in-2",level:4}],c={toc:s};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PageInfo"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"page"},"page"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"page"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L699"},"packages/core/src/data/types/entities.ts:699")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"totalitems"},"totalItems"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"totalItems"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L698"},"packages/core/src/data/types/entities.ts:698")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"totalpages"},"totalPages"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"totalPages"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L697"},"packages/core/src/data/types/entities.ts:697")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/bd37eed7.9f076cc3.js b/assets/js/bd37eed7.78530f2b.js similarity index 92% rename from assets/js/bd37eed7.9f076cc3.js rename to assets/js/bd37eed7.78530f2b.js index 8891948fb..eea495e80 100644 --- a/assets/js/bd37eed7.9f076cc3.js +++ b/assets/js/bd37eed7.78530f2b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6593],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),c=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=r,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return a?n.createElement(h,l(l({ref:t},d),{},{components:a})):n.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:r,l[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.react.IHeadingBlock",title:"Interface: IHeadingBlock",sidebar_label:"@headstartwp/core.react.IHeadingBlock",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IHeadingBlock",id:"interfaces/headstartwp_core.react.IHeadingBlock",title:"Interface: IHeadingBlock",description:"@headstartwp/core.react.IHeadingBlock",source:"@site/docs/interfaces/headstartwp_core.react.IHeadingBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IHeadingBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IHeadingBlock",title:"Interface: IHeadingBlock",sidebar_label:"@headstartwp/core.react.IHeadingBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IGroupBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock"},next:{title:"@headstartwp/core.react.IImageBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IHeadingBlock"),(0,r.kt)("p",null,"The common interface for a block transform component"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadingBlockProps")),">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IHeadingBlock"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classname"},"className"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"component"},"component"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"component"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadingBlockProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadingBlockProps")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6593],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),d=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=d(e.components);return n.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),s=d(a),m=r,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return a?n.createElement(h,l(l({ref:t},c),{},{components:a})):n.createElement(h,l({ref:t},c))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:r,l[1]=o;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.react.IHeadingBlock",title:"Interface: IHeadingBlock",sidebar_label:"@headstartwp/core.react.IHeadingBlock",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IHeadingBlock",id:"interfaces/headstartwp_core.react.IHeadingBlock",title:"Interface: IHeadingBlock",description:"@headstartwp/core.react.IHeadingBlock",source:"@site/docs/interfaces/headstartwp_core.react.IHeadingBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IHeadingBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IHeadingBlock",title:"Interface: IHeadingBlock",sidebar_label:"@headstartwp/core.react.IHeadingBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IGroupBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock"},next:{title:"@headstartwp/core.react.IImageBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IHeadingBlock"),(0,r.kt)("p",null,"The common interface for a block transform component"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadingBlockProps")),">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IHeadingBlock"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classname"},"className"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"component"},"component"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"component"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadingBlockProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadingBlockProps")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/bdcbc508.e061b9f9.js b/assets/js/bdcbc508.23ab3427.js similarity index 89% rename from assets/js/bdcbc508.e061b9f9.js rename to assets/js/bdcbc508.23ab3427.js index 7a6d03bf0..3bec88add 100644 --- a/assets/js/bdcbc508.e061b9f9.js +++ b/assets/js/bdcbc508.23ab3427.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8039],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function s(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var i=r.createContext({}),l=function(e){var t=r.useContext(i),a=t;return e&&(a="function"==typeof e?e(t):s(s({},t),e)),a},d=function(e){var t=l(e.components);return r.createElement(i.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,i=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),c=l(a),u=n,h=c["".concat(i,".").concat(u)]||c[u]||k[u]||o;return a?r.createElement(h,s(s({ref:t},d),{},{components:a})):r.createElement(h,s({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,s=new Array(o);s[0]=u;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p[c]="string"==typeof e?e:n,s[1]=p;for(var l=2;l{a.r(t),a.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>c,frontMatter:()=>o,metadata:()=>p,toc:()=>l});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.usePostsResponse",title:"Interface: usePostsResponse",sidebar_label:"@headstartwp/core.react.usePostsResponse",custom_edit_url:null},s=void 0,p={unversionedId:"interfaces/headstartwp_core.react.usePostsResponse",id:"interfaces/headstartwp_core.react.usePostsResponse",title:"Interface: usePostsResponse",description:"@headstartwp/core.react.usePostsResponse",source:"@site/docs/interfaces/headstartwp_core.react.usePostsResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.usePostsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.usePostsResponse",title:"Interface: usePostsResponse",sidebar_label:"@headstartwp/core.react.usePostsResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.usePostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"},next:{title:"@headstartwp/core.react.useSearchResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"}},i={},l=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"pageType",id:"pagetype",level:3},{value:"Defined in",id:"defined-in-4",level:4}],d={toc:l};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".usePostsResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"usePostsResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"pageInfo")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"posts")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"queriedObject")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject")))))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/useFetchPosts.ts#L59"},"packages/core/src/react/hooks/useFetchPosts.ts:59")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"pagetype"},"pageType"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"pageType"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#pagetype"},(0,n.kt)("inlineCode",{parentName:"a"},"PageType"))),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/useFetchPosts.ts#L64"},"packages/core/src/react/hooks/useFetchPosts.ts:64")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8039],{3905:(e,t,a)=>{a.d(t,{Zo:()=>l,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function s(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var i=r.createContext({}),d=function(e){var t=r.useContext(i),a=t;return e&&(a="function"==typeof e?e(t):s(s({},t),e)),a},l=function(e){var t=d(e.components);return r.createElement(i.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,i=e.parentName,l=p(e,["components","mdxType","originalType","parentName"]),c=d(a),u=n,h=c["".concat(i,".").concat(u)]||c[u]||k[u]||o;return a?r.createElement(h,s(s({ref:t},l),{},{components:a})):r.createElement(h,s({ref:t},l))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,s=new Array(o);s[0]=u;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p[c]="string"==typeof e?e:n,s[1]=p;for(var d=2;d{a.r(t),a.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>c,frontMatter:()=>o,metadata:()=>p,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.usePostsResponse",title:"Interface: usePostsResponse",sidebar_label:"@headstartwp/core.react.usePostsResponse",custom_edit_url:null},s=void 0,p={unversionedId:"interfaces/headstartwp_core.react.usePostsResponse",id:"interfaces/headstartwp_core.react.usePostsResponse",title:"Interface: usePostsResponse",description:"@headstartwp/core.react.usePostsResponse",source:"@site/docs/interfaces/headstartwp_core.react.usePostsResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.usePostsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.usePostsResponse",title:"Interface: usePostsResponse",sidebar_label:"@headstartwp/core.react.usePostsResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.usePostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"},next:{title:"@headstartwp/core.react.useSearchResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"}},i={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"pageType",id:"pagetype",level:3},{value:"Defined in",id:"defined-in-4",level:4}],l={toc:d};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},l,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".usePostsResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"usePostsResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"pageInfo")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"posts")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"queriedObject")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject")))))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/useFetchPosts.ts#L59"},"packages/core/src/react/hooks/useFetchPosts.ts:59")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"pagetype"},"pageType"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"pageType"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#pagetype"},(0,n.kt)("inlineCode",{parentName:"a"},"PageType"))),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/useFetchPosts.ts#L64"},"packages/core/src/react/hooks/useFetchPosts.ts:64")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c0c5ccb8.22c697da.js b/assets/js/c0c5ccb8.37f94642.js similarity index 98% rename from assets/js/c0c5ccb8.22c697da.js rename to assets/js/c0c5ccb8.37f94642.js index 3b1a632ea..dab57959d 100644 --- a/assets/js/c0c5ccb8.22c697da.js +++ b/assets/js/c0c5ccb8.37f94642.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7721],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var s=n.createContext({}),c=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},p=function(e){var t=c(e.components);return n.createElement(s.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),u=c(r),f=a,m=u["".concat(s,".").concat(f)]||u[f]||d[f]||i;return r?n.createElement(m,o(o({ref:t},p),{},{components:r})):n.createElement(m,o({ref:t},p))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,o=new Array(i);o[0]=f;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[u]="string"==typeof e?e:a,o[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var n=r(7462),a=(r(7294),r(3905));const i={},o="Linaria (CSS-in-JS)",l={unversionedId:"Guides/linaria",id:"Guides/linaria",title:"Linaria (CSS-in-JS)",description:"HeadstartWP offers a straightforward integration with Linaria, a zero-runtime CSS-in-JS solution. To use it, simply install the following linaria packages.",source:"@site/documentation/08-Guides/linaria.md",sourceDirName:"08-Guides",slug:"/Guides/linaria",permalink:"/docs/learn/Guides/linaria",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/08-Guides/linaria.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"A/B Test SPA vs MPA navigation",permalink:"/docs/learn/Guides/ab-test-link"},next:{title:"TypeScript",permalink:"/docs/learn/Guides/typescript"}},s={},c=[],p={toc:c};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"linaria-css-in-js"},"Linaria (CSS-in-JS)"),(0,a.kt)("p",null,"HeadstartWP offers a straightforward integration with ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/callstack/linaria"},"Linaria"),", a zero-runtime CSS-in-JS solution. To use it, simply install the following linaria packages."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"npm install --save-dev @linaria/babel-preset @linaria/core @linaria/react @linaria/shaker @linaria/webpack-loader\n")),(0,a.kt)("p",null,"The ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_next.config/#withheadstartwpconfig"},"withHeadstartWPConfig")," function will detect the presence of the Linaria packages and will enable the build steps necessary to compile Linaria."),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"If you're on a monorepo setup, these packages should be installed on the Next.js project.")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7721],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var s=n.createContext({}),c=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},p=function(e){var t=c(e.components);return n.createElement(s.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),u=c(r),f=a,m=u["".concat(s,".").concat(f)]||u[f]||d[f]||i;return r?n.createElement(m,o(o({ref:t},p),{},{components:r})):n.createElement(m,o({ref:t},p))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,o=new Array(i);o[0]=f;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[u]="string"==typeof e?e:a,o[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var n=r(7462),a=(r(7294),r(3905));const i={},o="Linaria (CSS-in-JS)",l={unversionedId:"Guides/linaria",id:"Guides/linaria",title:"Linaria (CSS-in-JS)",description:"HeadstartWP offers a straightforward integration with Linaria, a zero-runtime CSS-in-JS solution. To use it, simply install the following linaria packages.",source:"@site/documentation/08-Guides/linaria.md",sourceDirName:"08-Guides",slug:"/Guides/linaria",permalink:"/docs/learn/Guides/linaria",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/08-Guides/linaria.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"A/B Test SPA vs MPA navigation",permalink:"/docs/learn/Guides/ab-test-link"},next:{title:"TypeScript",permalink:"/docs/learn/Guides/typescript"}},s={},c=[],p={toc:c};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"linaria-css-in-js"},"Linaria (CSS-in-JS)"),(0,a.kt)("p",null,"HeadstartWP offers a straightforward integration with ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/callstack/linaria"},"Linaria"),", a zero-runtime CSS-in-JS solution. To use it, simply install the following linaria packages."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"npm install --save-dev @linaria/babel-preset @linaria/core @linaria/react @linaria/shaker @linaria/webpack-loader\n")),(0,a.kt)("p",null,"The ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_next.config/#withheadstartwpconfig"},"withHeadstartWPConfig")," function will detect the presence of the Linaria packages and will enable the build steps necessary to compile Linaria."),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"If you're on a monorepo setup, these packages should be installed on the Next.js project.")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c10c719f.bcb79b79.js b/assets/js/c10c719f.fb727937.js similarity index 98% rename from assets/js/c10c719f.bcb79b79.js rename to assets/js/c10c719f.fb727937.js index eb9da419c..ba3410fe4 100644 --- a/assets/js/c10c719f.bcb79b79.js +++ b/assets/js/c10c719f.fb727937.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9956],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>g});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),d=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=d(e.components);return a.createElement(p.Provider,{value:t},e.children)},f="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),f=d(n),m=r,g=f["".concat(p,".").concat(m)]||f[m]||c[m]||i;return n?a.createElement(g,l(l({ref:t},s),{},{components:n})):a.createElement(g,l({ref:t},s))}));function g(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[f]="string"==typeof e?e:r,l[1]=o;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>f,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var a=n(7462),r=(n(7294),n(3905));const i={id:"headstartwp_next.config",title:"Namespace: config",sidebar_label:"@headstartwp/next.config",custom_edit_url:null},l=void 0,o={unversionedId:"namespaces/headstartwp_next.config",id:"namespaces/headstartwp_next.config",title:"Namespace: config",description:"@headstartwp/next.config",source:"@site/docs/namespaces/headstartwp_next.config.md",sourceDirName:"namespaces",slug:"/namespaces/headstartwp_next.config",permalink:"/docs/api/namespaces/headstartwp_next.config",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_next.config",title:"Namespace: config",sidebar_label:"@headstartwp/next.config",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react",permalink:"/docs/api/namespaces/headstartwp_core.react"},next:{title:"@headstartwp/next.middlewares",permalink:"/docs/api/namespaces/headstartwp_next.middlewares"}},p={},d=[{value:"@headstartwp/next/config",id:"headstartwpnextconfig",level:2},{value:"Usage",id:"usage",level:3},{value:"Functions",id:"functions",level:2},{value:"withHeadlessConfig",id:"withheadlessconfig",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"withHeadstartWPConfig",id:"withheadstartwpconfig",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4}],s={toc:d};function f(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next"},"@headstartwp/next"),".config"),(0,r.kt)("h2",{id:"headstartwpnextconfig"},"@headstartwp/next/config"),(0,r.kt)("p",null,"The config export of the ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/next")," package."),(0,r.kt)("h3",{id:"usage"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { withHeadlessConfig } from '@headstartwp/next/config';\n")),(0,r.kt)("h2",{id:"functions"},"Functions"),(0,r.kt)("h3",{id:"withheadlessconfig"},"withHeadlessConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"withHeadlessConfig"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"nextConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"headlessConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"withHeadstarWPConfigOptions?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"NextConfig")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nextConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextConfig"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"headlessConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"HeadlessConfig"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withHeadstarWPConfigOptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withHeadstarWPConfigOptions.injectConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"NextConfig")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/config/withHeadstartWPConfig.ts#L268"},"packages/next/src/config/withHeadstartWPConfig.ts:268")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"withheadstartwpconfig"},"withHeadstartWPConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"withHeadstartWPConfig"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"nextConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"headlessConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"withHeadstarWPConfigOptions?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"NextConfig")),(0,r.kt)("p",null,"HOC used to wrap the nextjs config object with the headless config object."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nextConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The nextjs config object")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"headlessConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"HeadlessConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The headless config")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withHeadstarWPConfigOptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withHeadstarWPConfigOptions.injectConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"NextConfig")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/config/withHeadstartWPConfig.ts#L58"},"packages/next/src/config/withHeadstartWPConfig.ts:58")))}f.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9956],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>g});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),d=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=d(e.components);return a.createElement(p.Provider,{value:t},e.children)},f="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),f=d(n),m=r,g=f["".concat(p,".").concat(m)]||f[m]||c[m]||i;return n?a.createElement(g,l(l({ref:t},s),{},{components:n})):a.createElement(g,l({ref:t},s))}));function g(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[f]="string"==typeof e?e:r,l[1]=o;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>f,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var a=n(7462),r=(n(7294),n(3905));const i={id:"headstartwp_next.config",title:"Namespace: config",sidebar_label:"@headstartwp/next.config",custom_edit_url:null},l=void 0,o={unversionedId:"namespaces/headstartwp_next.config",id:"namespaces/headstartwp_next.config",title:"Namespace: config",description:"@headstartwp/next.config",source:"@site/docs/namespaces/headstartwp_next.config.md",sourceDirName:"namespaces",slug:"/namespaces/headstartwp_next.config",permalink:"/docs/api/namespaces/headstartwp_next.config",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_next.config",title:"Namespace: config",sidebar_label:"@headstartwp/next.config",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react",permalink:"/docs/api/namespaces/headstartwp_core.react"},next:{title:"@headstartwp/next.middlewares",permalink:"/docs/api/namespaces/headstartwp_next.middlewares"}},p={},d=[{value:"@headstartwp/next/config",id:"headstartwpnextconfig",level:2},{value:"Usage",id:"usage",level:3},{value:"Functions",id:"functions",level:2},{value:"withHeadlessConfig",id:"withheadlessconfig",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"withHeadstartWPConfig",id:"withheadstartwpconfig",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4}],s={toc:d};function f(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next"},"@headstartwp/next"),".config"),(0,r.kt)("h2",{id:"headstartwpnextconfig"},"@headstartwp/next/config"),(0,r.kt)("p",null,"The config export of the ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/next")," package."),(0,r.kt)("h3",{id:"usage"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { withHeadlessConfig } from '@headstartwp/next/config';\n")),(0,r.kt)("h2",{id:"functions"},"Functions"),(0,r.kt)("h3",{id:"withheadlessconfig"},"withHeadlessConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"withHeadlessConfig"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"nextConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"headlessConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"withHeadstarWPConfigOptions?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"NextConfig")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nextConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextConfig"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"headlessConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"HeadlessConfig"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withHeadstarWPConfigOptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withHeadstarWPConfigOptions.injectConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"NextConfig")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/config/withHeadstartWPConfig.ts#L268"},"packages/next/src/config/withHeadstartWPConfig.ts:268")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"withheadstartwpconfig"},"withHeadstartWPConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"withHeadstartWPConfig"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"nextConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"headlessConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"withHeadstarWPConfigOptions?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"NextConfig")),(0,r.kt)("p",null,"HOC used to wrap the nextjs config object with the headless config object."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nextConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The nextjs config object")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"headlessConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"HeadlessConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The headless config")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withHeadstarWPConfigOptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withHeadstarWPConfigOptions.injectConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"NextConfig")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/config/withHeadstartWPConfig.ts#L58"},"packages/next/src/config/withHeadstartWPConfig.ts:58")))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c4bf4659.7afa5927.js b/assets/js/c4bf4659.719fbaf6.js similarity index 88% rename from assets/js/c4bf4659.7afa5927.js rename to assets/js/c4bf4659.719fbaf6.js index 88e4b8d97..b9c10d891 100644 --- a/assets/js/c4bf4659.7afa5927.js +++ b/assets/js/c4bf4659.719fbaf6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[856],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function p(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var c=a.createContext({}),o=function(e){var t=a.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},s=function(e){var t=o(e.components);return a.createElement(c.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,c=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),d=o(r),m=n,h=d["".concat(c,".").concat(m)]||d[m]||k[m]||i;return r?a.createElement(h,p(p({ref:t},s),{},{components:r})):a.createElement(h,p({ref:t},s))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,p=new Array(i);p[0]=m;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l[d]="string"==typeof e?e:n,p[1]=l;for(var o=2;o{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>p,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>o});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.SpacerBlockProps",title:"Interface: SpacerBlockProps",sidebar_label:"@headstartwp/core.react.SpacerBlockProps",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.react.SpacerBlockProps",id:"interfaces/headstartwp_core.react.SpacerBlockProps",title:"Interface: SpacerBlockProps",description:"@headstartwp/core.react.SpacerBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.SpacerBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.SpacerBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.SpacerBlockProps",title:"Interface: SpacerBlockProps",sidebar_label:"@headstartwp/core.react.SpacerBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.SettingsProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},next:{title:"@headstartwp/core.react.StylesElementsPropertiesComplete",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete"}},c={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"height",id:"height",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:o};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".SpacerBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SpacerBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"height"},"height"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"height"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/SpacerBlock.tsx#L7"},"packages/core/src/react/blocks/SpacerBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[856],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function p(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var o=a.createContext({}),c=function(e){var t=a.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(o,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,p(p({ref:t},d),{},{components:r})):a.createElement(h,p({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,p=new Array(i);p[0]=m;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l[s]="string"==typeof e?e:n,p[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.SpacerBlockProps",title:"Interface: SpacerBlockProps",sidebar_label:"@headstartwp/core.react.SpacerBlockProps",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.react.SpacerBlockProps",id:"interfaces/headstartwp_core.react.SpacerBlockProps",title:"Interface: SpacerBlockProps",description:"@headstartwp/core.react.SpacerBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.SpacerBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.SpacerBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.SpacerBlockProps",title:"Interface: SpacerBlockProps",sidebar_label:"@headstartwp/core.react.SpacerBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.SettingsProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},next:{title:"@headstartwp/core.react.StylesElementsPropertiesComplete",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"height",id:"height",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".SpacerBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SpacerBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"height"},"height"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"height"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/SpacerBlock.tsx#L7"},"packages/core/src/react/blocks/SpacerBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c75a8848.9c549951.js b/assets/js/c75a8848.57239e56.js similarity index 96% rename from assets/js/c75a8848.9c549951.js rename to assets/js/c75a8848.57239e56.js index a006d0bda..846693f06 100644 --- a/assets/js/c75a8848.9c549951.js +++ b/assets/js/c75a8848.57239e56.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3435],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var l=r.createContext({}),d=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return r.createElement(l.Provider,{value:t},e.children)},h="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),h=d(a),m=n,k=h["".concat(l,".").concat(m)]||h[m]||c[m]||i;return a?r.createElement(k,p(p({ref:t},o),{},{components:a})):r.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[h]="string"==typeof e?e:n,p[1]=s;for(var d=2;d{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>h,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.AuthorArchiveFetchStrategy",title:"Class: AuthorArchiveFetchStrategy",sidebar_label:"@headstartwp/core.AuthorArchiveFetchStrategy",custom_edit_url:null},p=void 0,s={unversionedId:"classes/headstartwp_core.AuthorArchiveFetchStrategy",id:"classes/headstartwp_core.AuthorArchiveFetchStrategy",title:"Class: AuthorArchiveFetchStrategy",description:"@headstartwp/core.AuthorArchiveFetchStrategy",source:"@site/docs/classes/headstartwp_core.AuthorArchiveFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.AuthorArchiveFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AuthorArchiveFetchStrategy",title:"Class: AuthorArchiveFetchStrategy",sidebar_label:"@headstartwp/core.AuthorArchiveFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AppSettingsStrategy",permalink:"/docs/api/classes/headstartwp_core.AppSettingsStrategy"},next:{title:"@headstartwp/core.Comment",permalink:"/docs/api/classes/headstartwp_core.Comment"}},l={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"locale",id:"locale",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"path",id:"path",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"Defined in",id:"defined-in-21",level:4}],o={toc:d};function h(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AuthorArchiveFetchStrategy"),(0,n.kt)("p",null,"The AuthorArchiveFetchStrategy extends the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy")," and performs author archive requests"),(0,n.kt)("p",null,"This strategy supports extracting endpoint params from url E.g:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/author-name/")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ author: 'author-name' }")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/author-name/page/2")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ author: 'author-name', page: 2 }"))),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"AuthorArchiveFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new AuthorArchiveFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L115"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:115")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L105"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:105")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L110"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:110")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"locale"},"locale"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"locale"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#locale"},"locale")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L212"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"path"},"path"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"path"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#path"},"path")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L210"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Handles taxonomy filters and switch endpoint based on post type"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L289"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"Before fetching posts, we need handle taxonomy and authors."),(0,n.kt)("p",null,"If the headless plugin is not being used, then additional requests needs to be made to get\nauthors and terms ids"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to parse")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"FetchOptions")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L393"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:393")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L530"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L404"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:404")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L227"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:227")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L369"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:369")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L214"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:214")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L218"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL"),(0,n.kt)("p",null,"It also takes into account the custom taxonomies specified in ",(0,n.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL path to extract params from")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"})))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AuthorArchiveFetchStrategy.ts#L20"},"packages/core/src/data/strategies/AuthorArchiveFetchStrategy.ts:20")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("p",null,"Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)"),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The response from the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L461"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L191"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:191")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L379"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:379")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L327"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L150"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:150")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-20"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L146"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:146")))}h.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3435],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var l=r.createContext({}),d=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return r.createElement(l.Provider,{value:t},e.children)},h="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),h=d(a),m=n,k=h["".concat(l,".").concat(m)]||h[m]||c[m]||i;return a?r.createElement(k,p(p({ref:t},o),{},{components:a})):r.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[h]="string"==typeof e?e:n,p[1]=s;for(var d=2;d{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>h,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.AuthorArchiveFetchStrategy",title:"Class: AuthorArchiveFetchStrategy",sidebar_label:"@headstartwp/core.AuthorArchiveFetchStrategy",custom_edit_url:null},p=void 0,s={unversionedId:"classes/headstartwp_core.AuthorArchiveFetchStrategy",id:"classes/headstartwp_core.AuthorArchiveFetchStrategy",title:"Class: AuthorArchiveFetchStrategy",description:"@headstartwp/core.AuthorArchiveFetchStrategy",source:"@site/docs/classes/headstartwp_core.AuthorArchiveFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.AuthorArchiveFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AuthorArchiveFetchStrategy",title:"Class: AuthorArchiveFetchStrategy",sidebar_label:"@headstartwp/core.AuthorArchiveFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AppSettingsStrategy",permalink:"/docs/api/classes/headstartwp_core.AppSettingsStrategy"},next:{title:"@headstartwp/core.Comment",permalink:"/docs/api/classes/headstartwp_core.Comment"}},l={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"locale",id:"locale",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"path",id:"path",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"Defined in",id:"defined-in-21",level:4}],o={toc:d};function h(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AuthorArchiveFetchStrategy"),(0,n.kt)("p",null,"The AuthorArchiveFetchStrategy extends the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy")," and performs author archive requests"),(0,n.kt)("p",null,"This strategy supports extracting endpoint params from url E.g:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/author-name/")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ author: 'author-name' }")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/author-name/page/2")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ author: 'author-name', page: 2 }"))),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"AuthorArchiveFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new AuthorArchiveFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L115"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:115")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L105"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:105")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L110"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:110")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"locale"},"locale"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"locale"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#locale"},"locale")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L212"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"path"},"path"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"path"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#path"},"path")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L210"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Handles taxonomy filters and switch endpoint based on post type"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L289"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"Before fetching posts, we need handle taxonomy and authors."),(0,n.kt)("p",null,"If the headless plugin is not being used, then additional requests needs to be made to get\nauthors and terms ids"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to parse")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"FetchOptions")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L393"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:393")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L530"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L404"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:404")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L227"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:227")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L369"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:369")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L214"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:214")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L218"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL"),(0,n.kt)("p",null,"It also takes into account the custom taxonomies specified in ",(0,n.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL path to extract params from")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"})))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AuthorArchiveFetchStrategy.ts#L20"},"packages/core/src/data/strategies/AuthorArchiveFetchStrategy.ts:20")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("p",null,"Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)"),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The response from the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L461"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L191"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:191")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L379"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:379")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L327"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L150"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:150")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-20"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L146"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:146")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c969edca.8d2be2f0.js b/assets/js/c969edca.c6bdf25c.js similarity index 96% rename from assets/js/c969edca.8d2be2f0.js rename to assets/js/c969edca.c6bdf25c.js index 79dbd2f9a..0537066da 100644 --- a/assets/js/c969edca.8d2be2f0.js +++ b/assets/js/c969edca.c6bdf25c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[313],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},l=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},f=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,l=i(e,["components","mdxType","originalType","parentName"]),d=c(r),f=n,h=d["".concat(p,".").concat(f)]||d[f]||u[f]||o;return r?a.createElement(h,s(s({ref:t},l),{},{components:r})):a.createElement(h,s({ref:t},l))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=f;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[d]="string"==typeof e?e:n,s[1]=i;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.FetchResponse",title:"Interface: FetchResponse",sidebar_label:"@headstartwp/core.FetchResponse",custom_edit_url:null},s=void 0,i={unversionedId:"interfaces/headstartwp_core.FetchResponse",id:"interfaces/headstartwp_core.FetchResponse",title:"Interface: FetchResponse",description:"@headstartwp/core.FetchResponse",source:"@site/docs/interfaces/headstartwp_core.FetchResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.FetchResponse",permalink:"/docs/api/interfaces/headstartwp_core.FetchResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.FetchResponse",title:"Interface: FetchResponse",sidebar_label:"@headstartwp/core.FetchResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.FetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.FetchOptions"},next:{title:"@headstartwp/core.FilterDataOptions",permalink:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"}},p={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"pageInfo",id:"pageinfo",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"queriedObject",id:"queriedobject",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"result",id:"result",level:3},{value:"Defined in",id:"defined-in-2",level:4}],l={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".FetchResponse"),(0,n.kt)("p",null,"The type of the fetch response"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"pageinfo"},"pageInfo"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))),(0,n.kt)("p",null,"Contains pagination information"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L46"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:46")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"queriedobject"},"queriedObject"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("p",null,"Queried Object information"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L51"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:51")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"result"},"result"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T")),(0,n.kt)("p",null,"Contains the actual data returned from the API"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L41"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:41")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[313],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},l=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},f=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,l=i(e,["components","mdxType","originalType","parentName"]),d=c(r),f=n,h=d["".concat(p,".").concat(f)]||d[f]||u[f]||o;return r?a.createElement(h,s(s({ref:t},l),{},{components:r})):a.createElement(h,s({ref:t},l))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=f;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[d]="string"==typeof e?e:n,s[1]=i;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.FetchResponse",title:"Interface: FetchResponse",sidebar_label:"@headstartwp/core.FetchResponse",custom_edit_url:null},s=void 0,i={unversionedId:"interfaces/headstartwp_core.FetchResponse",id:"interfaces/headstartwp_core.FetchResponse",title:"Interface: FetchResponse",description:"@headstartwp/core.FetchResponse",source:"@site/docs/interfaces/headstartwp_core.FetchResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.FetchResponse",permalink:"/docs/api/interfaces/headstartwp_core.FetchResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.FetchResponse",title:"Interface: FetchResponse",sidebar_label:"@headstartwp/core.FetchResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.FetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.FetchOptions"},next:{title:"@headstartwp/core.FilterDataOptions",permalink:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"}},p={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"pageInfo",id:"pageinfo",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"queriedObject",id:"queriedobject",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"result",id:"result",level:3},{value:"Defined in",id:"defined-in-2",level:4}],l={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".FetchResponse"),(0,n.kt)("p",null,"The type of the fetch response"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"pageinfo"},"pageInfo"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))),(0,n.kt)("p",null,"Contains pagination information"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L46"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:46")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"queriedobject"},"queriedObject"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("p",null,"Queried Object information"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L51"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:51")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"result"},"result"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T")),(0,n.kt)("p",null,"Contains the actual data returned from the API"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L41"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:41")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c9e017d7.c32d1226.js b/assets/js/c9e017d7.42527c1a.js similarity index 98% rename from assets/js/c9e017d7.c32d1226.js rename to assets/js/c9e017d7.42527c1a.js index 89fee4a3e..15b7f7270 100644 --- a/assets/js/c9e017d7.c32d1226.js +++ b/assets/js/c9e017d7.42527c1a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4038],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>u});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var o=a.createContext({}),p=function(e){var t=a.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return a.createElement(o.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),c=p(r),m=n,u=c["".concat(o,".").concat(m)]||c[m]||k[m]||i;return r?a.createElement(u,l(l({ref:t},s),{},{components:r})):a.createElement(u,l({ref:t},s))}));function u(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=m;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d[c]="string"==typeof e?e:n,l[1]=d;for(var p=2;p{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>d,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.FetchError",title:"Class: FetchError",sidebar_label:"@headstartwp/core.FetchError",custom_edit_url:null},l=void 0,d={unversionedId:"classes/headstartwp_core.FetchError",id:"classes/headstartwp_core.FetchError",title:"Class: FetchError",description:"@headstartwp/core.FetchError",source:"@site/docs/classes/headstartwp_core.FetchError.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.FetchError",permalink:"/docs/api/classes/headstartwp_core.FetchError",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.FetchError",title:"Class: FetchError",sidebar_label:"@headstartwp/core.FetchError",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.EndpointError",permalink:"/docs/api/classes/headstartwp_core.EndpointError"},next:{title:"@headstartwp/core.FrameworkError",permalink:"/docs/api/classes/headstartwp_core.FrameworkError"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"cause",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"stack",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"prepareStackTrace",id:"preparestacktrace",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:p};function c(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".FetchError"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("inlineCode",{parentName:"p"},"Error")),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"FetchError"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new FetchError"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"message"),")"),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"message")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,"Error.constructor"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/utils/errors.ts#L11"},"packages/core/src/utils/errors.ts:11")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"cause"},"cause"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"cause"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,"Error.cause"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"message"},"message"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"message"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,"Error.message"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1054"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,"Error.name"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1053"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"stack"},"stack"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"stack"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,"Error.stack"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1055"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:127"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"preparestacktrace"},"prepareStackTrace"),(0,n.kt)("p",null,"\u25aa ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"prepareStackTrace"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"err"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"stackTraces"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"CallSite"),"[]) => ",(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"err"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"stackTraces"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("p",null,"Optional override for formatting stack traces"),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"See"))),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces"},"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces")),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"err")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Error"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"stackTraces")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"CallSite"),"[]")))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,"Error.prepareStackTrace"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:140"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"stacktracelimit"},"stackTraceLimit"),(0,n.kt)("p",null,"\u25aa ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("strong",{parentName:"p"},"stackTraceLimit"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,"Error.stackTraceLimit"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:142"),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"capturestacktrace"},"captureStackTrace"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("strong",{parentName:"p"},"captureStackTrace"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"targetObject"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"constructorOpt?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"Create .stack property on a target object"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"targetObject")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Object"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"constructorOpt?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Function"))))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,"Error.captureStackTrace"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:133"))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4038],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>u});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var o=a.createContext({}),p=function(e){var t=a.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return a.createElement(o.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),c=p(r),m=n,u=c["".concat(o,".").concat(m)]||c[m]||k[m]||i;return r?a.createElement(u,l(l({ref:t},s),{},{components:r})):a.createElement(u,l({ref:t},s))}));function u(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=m;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d[c]="string"==typeof e?e:n,l[1]=d;for(var p=2;p{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>d,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.FetchError",title:"Class: FetchError",sidebar_label:"@headstartwp/core.FetchError",custom_edit_url:null},l=void 0,d={unversionedId:"classes/headstartwp_core.FetchError",id:"classes/headstartwp_core.FetchError",title:"Class: FetchError",description:"@headstartwp/core.FetchError",source:"@site/docs/classes/headstartwp_core.FetchError.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.FetchError",permalink:"/docs/api/classes/headstartwp_core.FetchError",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.FetchError",title:"Class: FetchError",sidebar_label:"@headstartwp/core.FetchError",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.EndpointError",permalink:"/docs/api/classes/headstartwp_core.EndpointError"},next:{title:"@headstartwp/core.FrameworkError",permalink:"/docs/api/classes/headstartwp_core.FrameworkError"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"cause",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"stack",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"prepareStackTrace",id:"preparestacktrace",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:p};function c(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".FetchError"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("inlineCode",{parentName:"p"},"Error")),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"FetchError"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new FetchError"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"message"),")"),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"message")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,"Error.constructor"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/utils/errors.ts#L11"},"packages/core/src/utils/errors.ts:11")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"cause"},"cause"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"cause"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,"Error.cause"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"message"},"message"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"message"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,"Error.message"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1054"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,"Error.name"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1053"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"stack"},"stack"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"stack"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,"Error.stack"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1055"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:127"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"preparestacktrace"},"prepareStackTrace"),(0,n.kt)("p",null,"\u25aa ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"prepareStackTrace"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"err"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"stackTraces"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"CallSite"),"[]) => ",(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"err"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"stackTraces"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("p",null,"Optional override for formatting stack traces"),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"See"))),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces"},"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces")),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"err")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Error"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"stackTraces")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"CallSite"),"[]")))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,"Error.prepareStackTrace"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:140"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"stacktracelimit"},"stackTraceLimit"),(0,n.kt)("p",null,"\u25aa ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("strong",{parentName:"p"},"stackTraceLimit"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,"Error.stackTraceLimit"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:142"),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"capturestacktrace"},"captureStackTrace"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("strong",{parentName:"p"},"captureStackTrace"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"targetObject"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"constructorOpt?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"Create .stack property on a target object"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"targetObject")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Object"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"constructorOpt?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Function"))))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,"Error.captureStackTrace"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:133"))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/cb8267fc.18de701a.js b/assets/js/cb8267fc.324fbbbf.js similarity index 77% rename from assets/js/cb8267fc.18de701a.js rename to assets/js/cb8267fc.324fbbbf.js index 7c836538b..83c0326e1 100644 --- a/assets/js/cb8267fc.18de701a.js +++ b/assets/js/cb8267fc.324fbbbf.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7625],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>w});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function d(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),s=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):d(d({},t),e)),a},o=function(e){var t=s(e.components);return r.createElement(p.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),c=s(a),u=n,w=c["".concat(p,".").concat(u)]||c[u]||m[u]||i;return a?r.createElement(w,d(d({ref:t},o),{},{components:a})):r.createElement(w,d({ref:t},o))}));function w(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,d=new Array(i);d[0]=u;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[c]="string"==typeof e?e:n,d[1]=l;for(var s=2;s{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>d,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>s});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_next.middlewares",title:"Namespace: middlewares",sidebar_label:"@headstartwp/next.middlewares",custom_edit_url:null},d=void 0,l={unversionedId:"namespaces/headstartwp_next.middlewares",id:"namespaces/headstartwp_next.middlewares",title:"Namespace: middlewares",description:"@headstartwp/next.middlewares",source:"@site/docs/namespaces/headstartwp_next.middlewares.md",sourceDirName:"namespaces",slug:"/namespaces/headstartwp_next.middlewares",permalink:"/docs/api/namespaces/headstartwp_next.middlewares",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_next.middlewares",title:"Namespace: middlewares",sidebar_label:"@headstartwp/next.middlewares",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/next.config",permalink:"/docs/api/namespaces/headstartwp_next.config"},next:{title:"@headstartwp/core.LOGTYPE",permalink:"/docs/api/enums/headstartwp_core.LOGTYPE"}},p={},s=[{value:"@headstartwp/next/middlewares",id:"headstartwpnextmiddlewares",level:2},{value:"Usage",id:"usage",level:3},{value:"Functions",id:"functions",level:2},{value:"AppMiddleware",id:"appmiddleware",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4}],o={toc:s};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next"},"@headstartwp/next"),".middlewares"),(0,n.kt)("h2",{id:"headstartwpnextmiddlewares"},"@headstartwp/next/middlewares"),(0,n.kt)("p",null,"The middlewares export of the `@headstartwp/next' package."),(0,n.kt)("h3",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { appMiddleware } from '@headstartwp/next/middlewares';\n")),(0,n.kt)("h2",{id:"functions"},"Functions"),(0,n.kt)("h3",{id:"appmiddleware"},"AppMiddleware"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"AppMiddleware"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"req"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"NextResponse"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"unknown"),">",">"),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"req")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"NextRequest"))))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"NextResponse"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"unknown"),">",">"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/next/src/middlewares/appMidleware.ts#L15"},"packages/next/src/middlewares/appMidleware.ts:15")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7625],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>w});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function d(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var d=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),s=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},o=function(e){var t=s(e.components);return r.createElement(p.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,d=e.originalType,p=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),c=s(a),u=n,w=c["".concat(p,".").concat(u)]||c[u]||m[u]||d;return a?r.createElement(w,i(i({ref:t},o),{},{components:a})):r.createElement(w,i({ref:t},o))}));function w(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var d=a.length,i=new Array(d);i[0]=u;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[c]="string"==typeof e?e:n,i[1]=l;for(var s=2;s{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>c,frontMatter:()=>d,metadata:()=>l,toc:()=>s});var r=a(7462),n=(a(7294),a(3905));const d={id:"headstartwp_next.middlewares",title:"Namespace: middlewares",sidebar_label:"@headstartwp/next.middlewares",custom_edit_url:null},i=void 0,l={unversionedId:"namespaces/headstartwp_next.middlewares",id:"namespaces/headstartwp_next.middlewares",title:"Namespace: middlewares",description:"@headstartwp/next.middlewares",source:"@site/docs/namespaces/headstartwp_next.middlewares.md",sourceDirName:"namespaces",slug:"/namespaces/headstartwp_next.middlewares",permalink:"/docs/api/namespaces/headstartwp_next.middlewares",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_next.middlewares",title:"Namespace: middlewares",sidebar_label:"@headstartwp/next.middlewares",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/next.config",permalink:"/docs/api/namespaces/headstartwp_next.config"},next:{title:"@headstartwp/core.LOGTYPE",permalink:"/docs/api/enums/headstartwp_core.LOGTYPE"}},p={},s=[{value:"@headstartwp/next/middlewares",id:"headstartwpnextmiddlewares",level:2},{value:"Usage",id:"usage",level:3},{value:"Functions",id:"functions",level:2},{value:"AppMiddleware",id:"appmiddleware",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4}],o={toc:s};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next"},"@headstartwp/next"),".middlewares"),(0,n.kt)("h2",{id:"headstartwpnextmiddlewares"},"@headstartwp/next/middlewares"),(0,n.kt)("p",null,"The middlewares export of the `@headstartwp/next' package."),(0,n.kt)("h3",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { appMiddleware } from '@headstartwp/next/middlewares';\n")),(0,n.kt)("h2",{id:"functions"},"Functions"),(0,n.kt)("h3",{id:"appmiddleware"},"AppMiddleware"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"AppMiddleware"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"req"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"NextResponse"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"unknown"),">",">"),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"req")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"NextRequest"))))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"NextResponse"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"unknown"),">",">"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/next/src/middlewares/appMidleware.ts#L15"},"packages/next/src/middlewares/appMidleware.ts:15")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/cf8aa22f.c78ac3af.js b/assets/js/cf8aa22f.041c0abe.js similarity index 91% rename from assets/js/cf8aa22f.c78ac3af.js rename to assets/js/cf8aa22f.041c0abe.js index 70261a582..7571cdaf1 100644 --- a/assets/js/cf8aa22f.c78ac3af.js +++ b/assets/js/cf8aa22f.041c0abe.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9236],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>f});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function s(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),o=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):s(s({},t),e)),a},d=function(e){var t=o(e.components);return r.createElement(p.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),c=o(a),u=n,f=c["".concat(p,".").concat(u)]||c[u]||h[u]||i;return a?r.createElement(f,s(s({ref:t},d),{},{components:a})):r.createElement(f,s({ref:t},d))}));function f(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,s=new Array(i);s[0]=u;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[c]="string"==typeof e?e:n,s[1]=l;for(var o=2;o{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>o});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.PostParams",title:"Interface: PostParams",sidebar_label:"@headstartwp/core.PostParams",custom_edit_url:null},s=void 0,l={unversionedId:"interfaces/headstartwp_core.PostParams",id:"interfaces/headstartwp_core.PostParams",title:"Interface: PostParams",description:"@headstartwp/core.PostParams",source:"@site/docs/interfaces/headstartwp_core.PostParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PostParams",permalink:"/docs/api/interfaces/headstartwp_core.PostParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostParams",title:"Interface: PostParams",sidebar_label:"@headstartwp/core.PostParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostOrPostsParams",permalink:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},next:{title:"@headstartwp/core.PostTypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"}},p={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"authToken",id:"authtoken",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"fullPath",id:"fullpath",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"lang",id:"lang",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"matchCurrentPath",id:"matchcurrentpath",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"postType",id:"posttype",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"revision",id:"revision",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-9",level:4}],d={toc:o};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostParams"),(0,n.kt)("p",null,"The EndpointParams supported by the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"},"SinglePostFetchStrategy")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PostParams"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"_embed"},"_","embed"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"The _embed param returned associated entities in the response"),(0,n.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_embed"},"_embed")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"_fields"},"_","fields"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_fields"},"_fields")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"authtoken"},"authToken"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"authToken"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The authToken, required to fetch revisions or non-published posts"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L53"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fullpath"},"fullPath"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"fullPath"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"If set, this is the path that will be checked if ",(0,n.kt)("inlineCode",{parentName:"p"},"slug")," is set or ",(0,n.kt)("inlineCode",{parentName:"p"},"matchCurrentPath")," is set to true."),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L63"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:63")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"id"},"id"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"id"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Number")),(0,n.kt)("p",null,"Fetch post by id"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L43"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:43")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"lang"},"lang"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"lang"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The polylang ?lang parameter."),(0,n.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#lang"},"lang")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"matchcurrentpath"},"matchCurrentPath"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"matchCurrentPath"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Whether post.link should be checked against current path"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L58"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"posttype"},"postType"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"postType"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"Post Types where we should look for"),(0,n.kt)("p",null,"If multiple post types are specified\nmultiple requests will be issued to each post type until a matching post is found"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L38"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:38")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"revision"},"revision"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"revision"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Boolean")),(0,n.kt)("p",null,"If set will fetch the latest post revision"),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L48"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:48")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"slug"},"slug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"slug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The slug of the post to fetch"),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L30"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:30")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9236],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function s(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),o=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):s(s({},t),e)),a},d=function(e){var t=o(e.components);return r.createElement(p.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),c=o(a),u=n,k=c["".concat(p,".").concat(u)]||c[u]||h[u]||i;return a?r.createElement(k,s(s({ref:t},d),{},{components:a})):r.createElement(k,s({ref:t},d))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,s=new Array(i);s[0]=u;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[c]="string"==typeof e?e:n,s[1]=l;for(var o=2;o{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>o});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.PostParams",title:"Interface: PostParams",sidebar_label:"@headstartwp/core.PostParams",custom_edit_url:null},s=void 0,l={unversionedId:"interfaces/headstartwp_core.PostParams",id:"interfaces/headstartwp_core.PostParams",title:"Interface: PostParams",description:"@headstartwp/core.PostParams",source:"@site/docs/interfaces/headstartwp_core.PostParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PostParams",permalink:"/docs/api/interfaces/headstartwp_core.PostParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostParams",title:"Interface: PostParams",sidebar_label:"@headstartwp/core.PostParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostOrPostsParams",permalink:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},next:{title:"@headstartwp/core.PostTypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"}},p={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"authToken",id:"authtoken",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"fullPath",id:"fullpath",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"lang",id:"lang",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"matchCurrentPath",id:"matchcurrentpath",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"postType",id:"posttype",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"revision",id:"revision",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-9",level:4}],d={toc:o};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostParams"),(0,n.kt)("p",null,"The EndpointParams supported by the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"},"SinglePostFetchStrategy")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PostParams"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"_embed"},"_","embed"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"The _embed param returned associated entities in the response"),(0,n.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_embed"},"_embed")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"_fields"},"_","fields"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_fields"},"_fields")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"authtoken"},"authToken"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"authToken"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The authToken, required to fetch revisions or non-published posts"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L53"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fullpath"},"fullPath"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"fullPath"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"If set, this is the path that will be checked if ",(0,n.kt)("inlineCode",{parentName:"p"},"slug")," is set or ",(0,n.kt)("inlineCode",{parentName:"p"},"matchCurrentPath")," is set to true."),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L63"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:63")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"id"},"id"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"id"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Number")),(0,n.kt)("p",null,"Fetch post by id"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L43"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:43")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"lang"},"lang"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"lang"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The polylang ?lang parameter."),(0,n.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#lang"},"lang")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"matchcurrentpath"},"matchCurrentPath"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"matchCurrentPath"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Whether post.link should be checked against current path"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L58"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"posttype"},"postType"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"postType"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"Post Types where we should look for"),(0,n.kt)("p",null,"If multiple post types are specified\nmultiple requests will be issued to each post type until a matching post is found"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L38"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:38")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"revision"},"revision"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"revision"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Boolean")),(0,n.kt)("p",null,"If set will fetch the latest post revision"),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L48"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:48")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"slug"},"slug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"slug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The slug of the post to fetch"),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L30"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:30")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/cfec6fcb.87bc1b59.js b/assets/js/cfec6fcb.c01b63b3.js similarity index 98% rename from assets/js/cfec6fcb.87bc1b59.js rename to assets/js/cfec6fcb.c01b63b3.js index 7f6dbd507..46a07e5b8 100644 --- a/assets/js/cfec6fcb.87bc1b59.js +++ b/assets/js/cfec6fcb.c01b63b3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9953],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>g});var a=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var s=a.createContext({}),c=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},d=function(e){var t=c(e.components);return a.createElement(s.Provider,{value:t},e.children)},p="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,o=e.mdxType,r=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),p=c(n),u=o,g=p["".concat(s,".").concat(u)]||p[u]||h[u]||r;return n?a.createElement(g,i(i({ref:t},d),{},{components:n})):a.createElement(g,i({ref:t},d))}));function g(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=n.length,i=new Array(r);i[0]=u;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[p]="string"==typeof e?e:o,i[1]=l;for(var c=2;c{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>l,toc:()=>c});var a=n(7462),o=(n(7294),n(3905));const r={sidebar_label:"Rendering Blocks in React Native",slug:"/gutenberg/rendering-blocks-in-react-native"},i="Rendering Blocks in React Native",l={unversionedId:"Gutenberg/rendering-blocks-in-react-native",id:"Gutenberg/rendering-blocks-in-react-native",title:"Rendering Blocks in React Native",description:"Introduction",source:"@site/documentation/05-Gutenberg/rendering-blocks-in-react-native.md",sourceDirName:"05-Gutenberg",slug:"/gutenberg/rendering-blocks-in-react-native",permalink:"/docs/learn/gutenberg/rendering-blocks-in-react-native",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/05-Gutenberg/rendering-blocks-in-react-native.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{sidebar_label:"Rendering Blocks in React Native",slug:"/gutenberg/rendering-blocks-in-react-native"},sidebar:"tutorialSidebar",previous:{title:"Rendering Custom Blocks",permalink:"/docs/learn/gutenberg/rendering-custom-blocks"},next:{title:"Previews",permalink:"/docs/learn/wordpress-integration/previews"}},s={},c=[{value:"Introduction",id:"introduction",level:2},{value:"Blocks Rendering",id:"blocks-rendering",level:2},{value:"Paragraph Block",id:"paragraph-block",level:2},{value:"Heading Block",id:"heading-block",level:2},{value:"Image Block",id:"image-block",level:2},{value:"Result",id:"result",level:2}],d={toc:c};function p(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"rendering-blocks-in-react-native"},"Rendering Blocks in React Native"),(0,o.kt)("h2",{id:"introduction"},"Introduction"),(0,o.kt)("p",null,"The BlocksRenderer component can also be used to render Gutenberg blocks in React Native, by rendering blocks to native components without using a webview."),(0,o.kt)("p",null,"The examples in this section are part of a demo react native expo hosted on the ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/nicholasio/headless-expo"},"headless-expo")," repo. This Demo app uses expo and the HeadstartWP to fetch a page and render Gutenberg blocks as react-native components."),(0,o.kt)("p",null,"All of the code for this demo app lives in ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/nicholasio/headless-expo/blob/trunk/App.js"},"App.js"),". Since the demo app is using the data-fetching hooks from the core package, we first need to wrap the App with the SettingsProvider component."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'export default function App() {\n return (\n \n \n \n \n \n \n );\n}\n')),(0,o.kt)("p",null,"We also need to inject the headless config. For now, we need to use a workaround to inject the headless config."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'import headlessConfig from "./headless.config";\n\nglobalThis.__10up__HEADLESS_CONFIG = { ...headlessConfig };\n')),(0,o.kt)("h2",{id:"blocks-rendering"},"Blocks Rendering"),(0,o.kt)("p",null,"The SinglePostComponent is the one that fetches a page and render its content"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'function SinglePostComponent() {\n const { loading, data } = useFetchPost({\n postType: "page",\n slug: "react-native-test",\n });\n\n if (loading) {\n return Loading...;\n }\n\n return (\n \n \n \n \n \n \n \n );\n}\n')),(0,o.kt)("p",null,'useFetchPost is the core implementation of the usePost. The next.js hooks are built on top of the core data-fetching hooks. The core data-fetching hooks can be used in any react environment. In this example, we\u2019re fetching a page, with a slug called "react-native-test".'),(0,o.kt)("p",null,"This is all we need to have a React Native app that fetches data from a WP instance. The next step is building out the Block components."),(0,o.kt)("p",null,"We\u2019ll start with EmptyBlock and RawText. We need to be very careful when rendering blocks in React Native as we can\u2019t render any text under a React Native View component and remember that ",(0,o.kt)("strong",{parentName:"p"},"we\u2019re not rendering this under a webview, we are rendering blocks as native components.")),(0,o.kt)("p",null,"Since we can\u2019t render blocks that haven\u2019t been implemented by us yet, we\u2019ll create an allowed block list! We\u2019ll do that in the EmptyBlock component."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'/**\n * A noop block\n *\n * You can also use this to create a "allowList" of blocks and ignore blocks you don\'t want to render\n *\n * @returns\n */\nconst EmptyBlock = () => <>;\n\nEmptyBlock.defaultProps = {\n /**\n * Essentially catches any empty text nodes to make sure they don\'t get rendered under a component\n *\n * @param {*} node\n * @returns\n */\n test: (node) => {\n const allowedBlocks = ["core/paragraph", "core/heading", "core/image"];\n\n // if this isn\'t an allowed block catch it\n // if this is an allowed block it should have been handled at this ppint\n if (\n node.type !== "text" &&\n !allowedBlocks.some((blockName) => isBlockByName(node, blockName))\n ) {\n return true;\n }\n\n return (\n node.type === "text" &&\n (node.parent === null || node.data?.trim().length === 0)\n );\n },\n};\n')),(0,o.kt)("p",null,"The goal of the EmptyBlock is to catch all non-allowed blocks and skip rendering them at all. Additionally, it also catches orphan text nodes that only contain whitespaces (this would catch things carriage returns, spacing around tags, etc\u2026)"),(0,o.kt)("p",null,"Note that we\u2019re using defaultProps to provide the test function. This has the same result of passing the test function as a prop directly."),(0,o.kt)("p",null,"The next step is implementing a RawText component."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'/**\n * Trims raw text nodes\n *\n * @param {*} param0\n * @returns\n */\nconst RawText = ({ domNode }) => {\n return domNode.data.trim();\n};\n\nRawText.defaultProps = {\n /**\n * Catches any non-orphans and non-empty text fields\n *\n * @param {*} node\n * @returns\n */\n test: (node) =>\n node.type === "text" &&\n node.parent !== null &&\n node.data?.trim().length >= 0,\n};\n')),(0,o.kt)("p",null,'The goal here is to trim all text nodes. This is mostly to clean up text nodes. Therefore, we catch any non-orphans and non-empty text field nodes and replace them with a "trimmed" version.'),(0,o.kt)("p",null,"Now we have ensured that we don\u2019t have lingering text nodes and that valid text node does not contain additional whitespaces at the beginning and end."),(0,o.kt)("h2",{id:"paragraph-block"},"Paragraph Block"),(0,o.kt)("p",null,"Implementing the Paragraph block is pretty simple. All we need to do is use the React Native Text component"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'import { /* ... */, Text} from "react-native";\n\nconst RNParagraphBlock = ({ children }) => {\n return {children};\n};\n')),(0,o.kt)("p",null,'Note that this is essentially replacing the "p" tag with a native "Text" component. "children" in this context represent text nodes that are processed via the "RawText" block. If we didn\u2019t render children here, RawText block would never be executed for this paragraph. It\u2019s recursive logic!'),(0,o.kt)("h2",{id:"heading-block"},"Heading Block"),(0,o.kt)("p",null,'The heading block is very similar, we leverage the "level" prop that\u2019s automatically passed by the HeadingBlock component. We use it to create a dynamic class name that contains the style for the heading.'),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'import { /* ... */, Text} from "react-native";\n\nconst RNHeadingBlock = ({ children, level }) => {\n return {children};\n};\n\nconst styles = StyleSheet.create({\n container: {\n flex: 1,\n backgroundColor: "#fff",\n alignItems: "center",\n justifyContent: "center",\n },\n headingLevel1: {\n fontWeight: "bold",\n fontSize: "26px",\n },\n headingLevel2: {\n fontWeight: "bold",\n fontSize: "20px",\n },\n});\n')),(0,o.kt)("h2",{id:"image-block"},"Image Block"),(0,o.kt)("p",null,'The last block we\u2019ll implement is the image block. It is a bit more complex but it first captures the image caption by looping through the DOM node children until it finds a "figcaption" Then it uses the "height", "width" and "src" props that are automatically passed by the ImageBlock component to render the image using the native "Image" component.'),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'import { /* ... */, Image, Text} from "react-native";\n\nconst RNImageBlock = ({ domNode, height, width, src }) => {\n const caption =\n domNode.children.find((el) => el.name === "figcaption")?.firstChild?.data ??\n "";\n return (\n <>\n \n {caption}\n \n );\n};\n')),(0,o.kt)("h2",{id:"result"},"Result"),(0,o.kt)("p",null,"The demo app should render something like this"),(0,o.kt)("p",null,(0,o.kt)("img",{alt:"Blocks App",src:n(1264).Z,width:"495",height:"1024"})))}p.isMDXComponent=!0},1264:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/blocks-app-8e0dc4891e16eece268a8dd31d9b9564.png"}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9953],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>g});var a=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var s=a.createContext({}),c=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},d=function(e){var t=c(e.components);return a.createElement(s.Provider,{value:t},e.children)},p="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,o=e.mdxType,r=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),p=c(n),u=o,g=p["".concat(s,".").concat(u)]||p[u]||h[u]||r;return n?a.createElement(g,i(i({ref:t},d),{},{components:n})):a.createElement(g,i({ref:t},d))}));function g(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=n.length,i=new Array(r);i[0]=u;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[p]="string"==typeof e?e:o,i[1]=l;for(var c=2;c{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>l,toc:()=>c});var a=n(7462),o=(n(7294),n(3905));const r={sidebar_label:"Rendering Blocks in React Native",slug:"/gutenberg/rendering-blocks-in-react-native"},i="Rendering Blocks in React Native",l={unversionedId:"Gutenberg/rendering-blocks-in-react-native",id:"Gutenberg/rendering-blocks-in-react-native",title:"Rendering Blocks in React Native",description:"Introduction",source:"@site/documentation/05-Gutenberg/rendering-blocks-in-react-native.md",sourceDirName:"05-Gutenberg",slug:"/gutenberg/rendering-blocks-in-react-native",permalink:"/docs/learn/gutenberg/rendering-blocks-in-react-native",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/05-Gutenberg/rendering-blocks-in-react-native.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{sidebar_label:"Rendering Blocks in React Native",slug:"/gutenberg/rendering-blocks-in-react-native"},sidebar:"tutorialSidebar",previous:{title:"Rendering Custom Blocks",permalink:"/docs/learn/gutenberg/rendering-custom-blocks"},next:{title:"Previews",permalink:"/docs/learn/wordpress-integration/previews"}},s={},c=[{value:"Introduction",id:"introduction",level:2},{value:"Blocks Rendering",id:"blocks-rendering",level:2},{value:"Paragraph Block",id:"paragraph-block",level:2},{value:"Heading Block",id:"heading-block",level:2},{value:"Image Block",id:"image-block",level:2},{value:"Result",id:"result",level:2}],d={toc:c};function p(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"rendering-blocks-in-react-native"},"Rendering Blocks in React Native"),(0,o.kt)("h2",{id:"introduction"},"Introduction"),(0,o.kt)("p",null,"The BlocksRenderer component can also be used to render Gutenberg blocks in React Native, by rendering blocks to native components without using a webview."),(0,o.kt)("p",null,"The examples in this section are part of a demo react native expo hosted on the ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/nicholasio/headless-expo"},"headless-expo")," repo. This Demo app uses expo and the HeadstartWP to fetch a page and render Gutenberg blocks as react-native components."),(0,o.kt)("p",null,"All of the code for this demo app lives in ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/nicholasio/headless-expo/blob/trunk/App.js"},"App.js"),". Since the demo app is using the data-fetching hooks from the core package, we first need to wrap the App with the SettingsProvider component."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'export default function App() {\n return (\n \n \n \n \n \n \n );\n}\n')),(0,o.kt)("p",null,"We also need to inject the headless config. For now, we need to use a workaround to inject the headless config."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'import headlessConfig from "./headless.config";\n\nglobalThis.__10up__HEADLESS_CONFIG = { ...headlessConfig };\n')),(0,o.kt)("h2",{id:"blocks-rendering"},"Blocks Rendering"),(0,o.kt)("p",null,"The SinglePostComponent is the one that fetches a page and render its content"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'function SinglePostComponent() {\n const { loading, data } = useFetchPost({\n postType: "page",\n slug: "react-native-test",\n });\n\n if (loading) {\n return Loading...;\n }\n\n return (\n \n \n \n \n \n \n \n );\n}\n')),(0,o.kt)("p",null,'useFetchPost is the core implementation of the usePost. The next.js hooks are built on top of the core data-fetching hooks. The core data-fetching hooks can be used in any react environment. In this example, we\u2019re fetching a page, with a slug called "react-native-test".'),(0,o.kt)("p",null,"This is all we need to have a React Native app that fetches data from a WP instance. The next step is building out the Block components."),(0,o.kt)("p",null,"We\u2019ll start with EmptyBlock and RawText. We need to be very careful when rendering blocks in React Native as we can\u2019t render any text under a React Native View component and remember that ",(0,o.kt)("strong",{parentName:"p"},"we\u2019re not rendering this under a webview, we are rendering blocks as native components.")),(0,o.kt)("p",null,"Since we can\u2019t render blocks that haven\u2019t been implemented by us yet, we\u2019ll create an allowed block list! We\u2019ll do that in the EmptyBlock component."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'/**\n * A noop block\n *\n * You can also use this to create a "allowList" of blocks and ignore blocks you don\'t want to render\n *\n * @returns\n */\nconst EmptyBlock = () => <>;\n\nEmptyBlock.defaultProps = {\n /**\n * Essentially catches any empty text nodes to make sure they don\'t get rendered under a component\n *\n * @param {*} node\n * @returns\n */\n test: (node) => {\n const allowedBlocks = ["core/paragraph", "core/heading", "core/image"];\n\n // if this isn\'t an allowed block catch it\n // if this is an allowed block it should have been handled at this ppint\n if (\n node.type !== "text" &&\n !allowedBlocks.some((blockName) => isBlockByName(node, blockName))\n ) {\n return true;\n }\n\n return (\n node.type === "text" &&\n (node.parent === null || node.data?.trim().length === 0)\n );\n },\n};\n')),(0,o.kt)("p",null,"The goal of the EmptyBlock is to catch all non-allowed blocks and skip rendering them at all. Additionally, it also catches orphan text nodes that only contain whitespaces (this would catch things carriage returns, spacing around tags, etc\u2026)"),(0,o.kt)("p",null,"Note that we\u2019re using defaultProps to provide the test function. This has the same result of passing the test function as a prop directly."),(0,o.kt)("p",null,"The next step is implementing a RawText component."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'/**\n * Trims raw text nodes\n *\n * @param {*} param0\n * @returns\n */\nconst RawText = ({ domNode }) => {\n return domNode.data.trim();\n};\n\nRawText.defaultProps = {\n /**\n * Catches any non-orphans and non-empty text fields\n *\n * @param {*} node\n * @returns\n */\n test: (node) =>\n node.type === "text" &&\n node.parent !== null &&\n node.data?.trim().length >= 0,\n};\n')),(0,o.kt)("p",null,'The goal here is to trim all text nodes. This is mostly to clean up text nodes. Therefore, we catch any non-orphans and non-empty text field nodes and replace them with a "trimmed" version.'),(0,o.kt)("p",null,"Now we have ensured that we don\u2019t have lingering text nodes and that valid text node does not contain additional whitespaces at the beginning and end."),(0,o.kt)("h2",{id:"paragraph-block"},"Paragraph Block"),(0,o.kt)("p",null,"Implementing the Paragraph block is pretty simple. All we need to do is use the React Native Text component"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'import { /* ... */, Text} from "react-native";\n\nconst RNParagraphBlock = ({ children }) => {\n return {children};\n};\n')),(0,o.kt)("p",null,'Note that this is essentially replacing the "p" tag with a native "Text" component. "children" in this context represent text nodes that are processed via the "RawText" block. If we didn\u2019t render children here, RawText block would never be executed for this paragraph. It\u2019s recursive logic!'),(0,o.kt)("h2",{id:"heading-block"},"Heading Block"),(0,o.kt)("p",null,'The heading block is very similar, we leverage the "level" prop that\u2019s automatically passed by the HeadingBlock component. We use it to create a dynamic class name that contains the style for the heading.'),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'import { /* ... */, Text} from "react-native";\n\nconst RNHeadingBlock = ({ children, level }) => {\n return {children};\n};\n\nconst styles = StyleSheet.create({\n container: {\n flex: 1,\n backgroundColor: "#fff",\n alignItems: "center",\n justifyContent: "center",\n },\n headingLevel1: {\n fontWeight: "bold",\n fontSize: "26px",\n },\n headingLevel2: {\n fontWeight: "bold",\n fontSize: "20px",\n },\n});\n')),(0,o.kt)("h2",{id:"image-block"},"Image Block"),(0,o.kt)("p",null,'The last block we\u2019ll implement is the image block. It is a bit more complex but it first captures the image caption by looping through the DOM node children until it finds a "figcaption" Then it uses the "height", "width" and "src" props that are automatically passed by the ImageBlock component to render the image using the native "Image" component.'),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'import { /* ... */, Image, Text} from "react-native";\n\nconst RNImageBlock = ({ domNode, height, width, src }) => {\n const caption =\n domNode.children.find((el) => el.name === "figcaption")?.firstChild?.data ??\n "";\n return (\n <>\n \n {caption}\n \n );\n};\n')),(0,o.kt)("h2",{id:"result"},"Result"),(0,o.kt)("p",null,"The demo app should render something like this"),(0,o.kt)("p",null,(0,o.kt)("img",{alt:"Blocks App",src:n(1264).Z,width:"495",height:"1024"})))}p.isMDXComponent=!0},1264:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/blocks-app-8e0dc4891e16eece268a8dd31d9b9564.png"}}]); \ No newline at end of file diff --git a/assets/js/d19e169a.203892cd.js b/assets/js/d19e169a.f805290d.js similarity index 98% rename from assets/js/d19e169a.203892cd.js rename to assets/js/d19e169a.f805290d.js index cf72588c5..e453fb44c 100644 --- a/assets/js/d19e169a.203892cd.js +++ b/assets/js/d19e169a.f805290d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4504],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var c=n.createContext({}),l=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},d=function(e){var t=l(e.components);return n.createElement(c.Provider,{value:t},e.children)},u="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,c=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),u=l(r),m=a,h=u["".concat(c,".").concat(m)]||u[m]||p[m]||o;return r?n.createElement(h,i(i({ref:t},d),{},{components:r})):n.createElement(h,i({ref:t},d))}));function h(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=m;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s[u]="string"==typeof e?e:a,i[1]=s;for(var l=2;l{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var n=r(7462),a=(r(7294),r(3905));const o={slug:"/wordpress-integration/basic-auth"},i="Basic Auth",s={unversionedId:"WordPress Integration/basic-auth",id:"WordPress Integration/basic-auth",title:"Basic Auth",description:"If WordPress is protected by Basic Auth (which is common during development) you can tell HeadstartWP the basic auth creds so that all",source:"@site/documentation/06-WordPress Integration/basic-auth.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/basic-auth",permalink:"/docs/learn/wordpress-integration/basic-auth",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/basic-auth.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{slug:"/wordpress-integration/basic-auth"},sidebar:"tutorialSidebar",previous:{title:"On-demand ISR revalidation",permalink:"/docs/learn/wordpress-integration/revalidate"},next:{title:"Feeds",permalink:"/docs/learn/wordpress-integration/feeds"}},c={},l=[],d={toc:l};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"basic-auth"},"Basic Auth"),(0,a.kt)("p",null,"If WordPress is protected by Basic Auth (which is common during development) you can tell HeadstartWP the basic auth creds so that all\nREST API requests include them. To do so, simply add the following env variables:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"WP_BASIC_AUTH_USERNAME=username\nWP_BASIC_AUTH_PASSWORD=password\n")),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"The above env variables will only be accessible server-side and therefore any client-side requests made directly to WordPress will fail. This happens because Next.js only includes env variables prefixed with ",(0,a.kt)("inlineCode",{parentName:"p"},"NEXT_PUBLIC_")," in the browser bundle."),(0,a.kt)("p",{parentName:"admonition"},"If you want your client-side requests to work, prefix the above variables with ",(0,a.kt)("inlineCode",{parentName:"p"},"NEXT_PUBLIC_"),". But note that the basic auth creds will be leaked to the public.")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4504],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var c=n.createContext({}),l=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},d=function(e){var t=l(e.components);return n.createElement(c.Provider,{value:t},e.children)},u="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,c=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),u=l(r),m=a,h=u["".concat(c,".").concat(m)]||u[m]||p[m]||o;return r?n.createElement(h,i(i({ref:t},d),{},{components:r})):n.createElement(h,i({ref:t},d))}));function h(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=m;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s[u]="string"==typeof e?e:a,i[1]=s;for(var l=2;l{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var n=r(7462),a=(r(7294),r(3905));const o={slug:"/wordpress-integration/basic-auth"},i="Basic Auth",s={unversionedId:"WordPress Integration/basic-auth",id:"WordPress Integration/basic-auth",title:"Basic Auth",description:"If WordPress is protected by Basic Auth (which is common during development) you can tell HeadstartWP the basic auth creds so that all",source:"@site/documentation/06-WordPress Integration/basic-auth.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/basic-auth",permalink:"/docs/learn/wordpress-integration/basic-auth",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/basic-auth.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{slug:"/wordpress-integration/basic-auth"},sidebar:"tutorialSidebar",previous:{title:"On-demand ISR revalidation",permalink:"/docs/learn/wordpress-integration/revalidate"},next:{title:"Feeds",permalink:"/docs/learn/wordpress-integration/feeds"}},c={},l=[],d={toc:l};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"basic-auth"},"Basic Auth"),(0,a.kt)("p",null,"If WordPress is protected by Basic Auth (which is common during development) you can tell HeadstartWP the basic auth creds so that all\nREST API requests include them. To do so, simply add the following env variables:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"WP_BASIC_AUTH_USERNAME=username\nWP_BASIC_AUTH_PASSWORD=password\n")),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"The above env variables will only be accessible server-side and therefore any client-side requests made directly to WordPress will fail. This happens because Next.js only includes env variables prefixed with ",(0,a.kt)("inlineCode",{parentName:"p"},"NEXT_PUBLIC_")," in the browser bundle."),(0,a.kt)("p",{parentName:"admonition"},"If you want your client-side requests to work, prefix the above variables with ",(0,a.kt)("inlineCode",{parentName:"p"},"NEXT_PUBLIC_"),". But note that the basic auth creds will be leaked to the public.")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d847ebfc.d3bab54b.js b/assets/js/d847ebfc.6bc109ac.js similarity index 99% rename from assets/js/d847ebfc.d3bab54b.js rename to assets/js/d847ebfc.6bc109ac.js index ef0d307a3..bbd07e460 100644 --- a/assets/js/d847ebfc.d3bab54b.js +++ b/assets/js/d847ebfc.6bc109ac.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[521],{3905:(e,t,n)=>{n.d(t,{Zo:()=>l,kt:()=>f});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var c=a.createContext({}),p=function(e){var t=a.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},l=function(e){var t=p(e.components);return a.createElement(c.Provider,{value:t},e.children)},d="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,c=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),d=p(n),u=r,f=d["".concat(c,".").concat(u)]||d[u]||h[u]||o;return n?a.createElement(f,i(i({ref:t},l),{},{components:n})):a.createElement(f,i({ref:t},l))}));function f(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,i=new Array(o);i[0]=u;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s[d]="string"==typeof e?e:r,i[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var a=n(7462),r=(n(7294),n(3905));const o={slug:"/data-fetching/prefetching"},i="Prefetching data on the server",s={unversionedId:"Data Fetching/prefetching-data-server",id:"Data Fetching/prefetching-data-server",title:"Prefetching data on the server",description:"To enable prefetching data on the server use the fetchHookData function alongside addHookData.",source:"@site/documentation/02 - Data Fetching/prefetching-data-server.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/prefetching",permalink:"/docs/learn/data-fetching/prefetching",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/prefetching-data-server.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{slug:"/data-fetching/prefetching"},sidebar:"tutorialSidebar",previous:{title:"Creating your own custom hooks",permalink:"/docs/learn/data-fetching/creating-your-own-custom-hooks"},next:{title:"Escaping & Sanitization",permalink:"/docs/learn/utilities/sanitization"}},c={},p=[],l={toc:p};function d(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"prefetching-data-on-the-server"},"Prefetching data on the server"),(0,r.kt)("p",null,"To enable prefetching data on the server use the ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData")," function alongside ",(0,r.kt)("inlineCode",{parentName:"p"},"addHookData"),".\nWe also recommend using the ",(0,r.kt)("inlineCode",{parentName:"p"},"handleError")," function and to wrap the ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData")," call in a try/catch."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"import { \n usePost, \n fetchHookData, \n addHookData, \n handleError\n} from '@headstartwp/next';\n\nconst params = { postType: ['post', 'page'] };\n\nconst SinglePostsPage = () => {\n const { data } = usePost(params);\n\n // when doing ssr/ssg data will always be available so handling loading/error state is optional\n\n return (\n
\n

{data?.post.title.rendered}

\n
\n );\n};\n\nexport default SinglePostsPage;\n\n// or export async function getServerSideProps(context)\nexport async function getStaticProps(context) {\n try {\n const usePostHook = await fetchHookData(usePost.fetcher(), context, { params });\n\n return addHookData([usePostHook], { myCustomProp: 'value' });\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"The ",(0,r.kt)("a",{parentName:"li",href:"/api/modules/headstartwp_next#fetchhookdata"},"fetchHookData")," function receives a ",(0,r.kt)("a",{parentName:"li",href:"/api/classes/headstartwp_core.AbstractFetchStrategy/"},"strategy"),", the Next.js context object and an object containing the params. The ",(0,r.kt)("inlineCode",{parentName:"li"},"params")," must match the params passed to the hook, hence why it's been moved into a variable outside of the ",(0,r.kt)("inlineCode",{parentName:"li"},"SinglePostsPage")," component."),(0,r.kt)("li",{parentName:"ul"},"The ",(0,r.kt)("a",{parentName:"li",href:"/api/modules/headstartwp_next#addhookdata"},"addHookData")," receives an array of responses returned by ",(0,r.kt)("inlineCode",{parentName:"li"},"fetchHookData")," and prepares that data to be returned to the page as props. If you need to pass additional props just pass them in the second argument."),(0,r.kt)("li",{parentName:"ul"},"The ",(0,r.kt)("a",{parentName:"li",href:"/api/modules/headstartwp_next#ahandleError"},"handleError")," function handles errors such as 404, redirects (when redirects are set to 404) among other things.")),(0,r.kt)("p",null,"We recommend reviewing the ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/tree/develop/projects/wp-nextjs"},"starter project")," for more examples of prefetching data on the server."))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[521],{3905:(e,t,n)=>{n.d(t,{Zo:()=>l,kt:()=>f});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var c=a.createContext({}),p=function(e){var t=a.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},l=function(e){var t=p(e.components);return a.createElement(c.Provider,{value:t},e.children)},d="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,c=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),d=p(n),u=r,f=d["".concat(c,".").concat(u)]||d[u]||h[u]||o;return n?a.createElement(f,i(i({ref:t},l),{},{components:n})):a.createElement(f,i({ref:t},l))}));function f(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,i=new Array(o);i[0]=u;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s[d]="string"==typeof e?e:r,i[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var a=n(7462),r=(n(7294),n(3905));const o={slug:"/data-fetching/prefetching"},i="Prefetching data on the server",s={unversionedId:"Data Fetching/prefetching-data-server",id:"Data Fetching/prefetching-data-server",title:"Prefetching data on the server",description:"To enable prefetching data on the server use the fetchHookData function alongside addHookData.",source:"@site/documentation/02 - Data Fetching/prefetching-data-server.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/prefetching",permalink:"/docs/learn/data-fetching/prefetching",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/prefetching-data-server.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{slug:"/data-fetching/prefetching"},sidebar:"tutorialSidebar",previous:{title:"Creating your own custom hooks",permalink:"/docs/learn/data-fetching/creating-your-own-custom-hooks"},next:{title:"Escaping & Sanitization",permalink:"/docs/learn/utilities/sanitization"}},c={},p=[],l={toc:p};function d(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"prefetching-data-on-the-server"},"Prefetching data on the server"),(0,r.kt)("p",null,"To enable prefetching data on the server use the ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData")," function alongside ",(0,r.kt)("inlineCode",{parentName:"p"},"addHookData"),".\nWe also recommend using the ",(0,r.kt)("inlineCode",{parentName:"p"},"handleError")," function and to wrap the ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData")," call in a try/catch."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"import { \n usePost, \n fetchHookData, \n addHookData, \n handleError\n} from '@headstartwp/next';\n\nconst params = { postType: ['post', 'page'] };\n\nconst SinglePostsPage = () => {\n const { data } = usePost(params);\n\n // when doing ssr/ssg data will always be available so handling loading/error state is optional\n\n return (\n
\n

{data?.post.title.rendered}

\n
\n );\n};\n\nexport default SinglePostsPage;\n\n// or export async function getServerSideProps(context)\nexport async function getStaticProps(context) {\n try {\n const usePostHook = await fetchHookData(usePost.fetcher(), context, { params });\n\n return addHookData([usePostHook], { myCustomProp: 'value' });\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"The ",(0,r.kt)("a",{parentName:"li",href:"/api/modules/headstartwp_next#fetchhookdata"},"fetchHookData")," function receives a ",(0,r.kt)("a",{parentName:"li",href:"/api/classes/headstartwp_core.AbstractFetchStrategy/"},"strategy"),", the Next.js context object and an object containing the params. The ",(0,r.kt)("inlineCode",{parentName:"li"},"params")," must match the params passed to the hook, hence why it's been moved into a variable outside of the ",(0,r.kt)("inlineCode",{parentName:"li"},"SinglePostsPage")," component."),(0,r.kt)("li",{parentName:"ul"},"The ",(0,r.kt)("a",{parentName:"li",href:"/api/modules/headstartwp_next#addhookdata"},"addHookData")," receives an array of responses returned by ",(0,r.kt)("inlineCode",{parentName:"li"},"fetchHookData")," and prepares that data to be returned to the page as props. If you need to pass additional props just pass them in the second argument."),(0,r.kt)("li",{parentName:"ul"},"The ",(0,r.kt)("a",{parentName:"li",href:"/api/modules/headstartwp_next#ahandleError"},"handleError")," function handles errors such as 404, redirects (when redirects are set to 404) among other things.")),(0,r.kt)("p",null,"We recommend reviewing the ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/tree/develop/projects/wp-nextjs"},"starter project")," for more examples of prefetching data on the server."))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d87415d1.8910ed97.js b/assets/js/d87415d1.0bcf814a.js similarity index 99% rename from assets/js/d87415d1.8910ed97.js rename to assets/js/d87415d1.0bcf814a.js index cb8dca4aa..96bcacaf5 100644 --- a/assets/js/d87415d1.8910ed97.js +++ b/assets/js/d87415d1.0bcf814a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5148],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),p=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},u=function(e){var t=p(e.components);return r.createElement(l.Provider,{value:t},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,u=o(e,["components","mdxType","originalType","parentName"]),d=p(n),h=a,m=d["".concat(l,".").concat(h)]||d[h]||c[h]||i;return n?r.createElement(m,s(s({ref:t},u),{},{components:n})):r.createElement(m,s({ref:t},u))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,s=new Array(i);s[0]=h;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o[d]="string"==typeof e?e:a,s[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var r=n(7462),a=(n(7294),n(3905));const i={sidebar_position:1,slug:"/wordpress-integration/multisite"},s="Multisite",o={unversionedId:"WordPress Integration/multisite",id:"WordPress Integration/multisite",title:"Multisite",description:"HeadstartWP has built-in support for WordPress multisite via the sites property in the headstartwp.config.js file. This transforms the Next.js app into a multi-tenant app.",source:"@site/documentation/06-WordPress Integration/multisite.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/multisite",permalink:"/docs/learn/wordpress-integration/multisite",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/multisite.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:1,frontMatter:{sidebar_position:1,slug:"/wordpress-integration/multisite"},sidebar:"tutorialSidebar",previous:{title:"Previews",permalink:"/docs/learn/wordpress-integration/previews"},next:{title:"On-demand ISR revalidation",permalink:"/docs/learn/wordpress-integration/revalidate"}},l={},p=[{value:"Usage",id:"usage",level:2},{value:"Config",id:"config",level:3},{value:"Internationalized routing",id:"internationalized-routing",level:4},{value:"Middleware",id:"middleware",level:3},{value:"Folder structure",id:"folder-structure",level:3},{value:"Creating Routes that target a specific site",id:"creating-routes-that-target-a-specific-site",level:3},{value:"Known Issues",id:"known-issues",level:2}],u={toc:p};function d(e){let{components:t,...i}=e;return(0,a.kt)("wrapper",(0,r.Z)({},u,i,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"multisite"},"Multisite"),(0,a.kt)("p",null,"HeadstartWP has built-in support for WordPress multisite via the ",(0,a.kt)("inlineCode",{parentName:"p"},"sites")," property in the ",(0,a.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," file. This transforms the Next.js app into a multi-tenant app."),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"sites")," option allows specifying as many sites you want to connect to your app. Each site must have a ",(0,a.kt)("inlineCode",{parentName:"p"},"sourceUrl")," and a ",(0,a.kt)("inlineCode",{parentName:"p"},"hostUrl"),". The ",(0,a.kt)("inlineCode",{parentName:"p"},"hostUrl")," will be used to match the current site and ",(0,a.kt)("inlineCode",{parentName:"p"},"sourceUrl")," indicates where content should be sourced from."),(0,a.kt)("p",null,"This feature does not require that all sites belong to the same multisite, you're free to connect the Next.js app to a completely separate WordPress instance, as long as that instance implements what your Next.js app needs."),(0,a.kt)("p",null,"Take a look at the ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/tree/develop/projects/wp-multisite-nextjs"},"multisite demo project")," to familiarize yourself with the set-up."),(0,a.kt)("h2",{id:"usage"},"Usage"),(0,a.kt)("h3",{id:"config"},"Config"),(0,a.kt)("p",null,"The first step is to declare all of your sites in ",(0,a.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js"),". In the example below we're declaring two sites."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"/**\n * Headless Config\n *\n * @type {import('@headstartwp/core').HeadlessConfig}\n */\nmodule.exports = {\n redirectStrategy: '404',\n useWordPressPlugin: true,\n\n sites: [\n {\n hostUrl: 'http://site1.localhost:3001',\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n\n },\n {\n hostUrl: 'http://site2.localhost:3001',\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL_2,\n },\n ],\n};\n")),(0,a.kt)("p",null,"In the example above we specify that all sites must use the WordPress plugin and that the redirect strategy should be ",(0,a.kt)("inlineCode",{parentName:"p"},"404"),". Then we're declaring two sites that will respond via the ",(0,a.kt)("a",{parentName:"p",href:"http://site1.localhost:3001"},"http://site1.localhost:3001")," and ",(0,a.kt)("a",{parentName:"p",href:"http://site2.localhost:3001"},"http://site2.localhost:3001")," URLs. The ",(0,a.kt)("inlineCode",{parentName:"p"},"sourceUrl")," for each comes from an env variable."),(0,a.kt)("p",null,"This means that when we visit ",(0,a.kt)("a",{parentName:"p",href:"http://site1.localhost:3001"},"http://site1.localhost:3001"),", the source URL specified by ",(0,a.kt)("inlineCode",{parentName:"p"},"NEXT_PUBLIC_HEADLESS_WP_URL")," will be used."),(0,a.kt)("h4",{id:"internationalized-routing"},"Internationalized routing"),(0,a.kt)("p",null,"If you're using ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/advanced-features/i18n-routing"},"Next.js i18n")," feature you can specify the locale in the site's config object and the locale will also be used when matching a site."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"/**\n * Headless Config\n *\n * @type {import('@headstartwp/core').HeadlessConfig}\n */\nmodule.exports = {\n redirectStrategy: '404',\n useWordPressPlugin: true,\n\n sites: [\n {\n hostUrl: 'http://site1.localhost:3001',\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n locale: 'en'\n },\n {\n hostUrl: 'http://site1.localhost:3001',\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL_2,\n locale: 'es'\n },\n ],\n};\n")),(0,a.kt)("p",null,"The above config means that ",(0,a.kt)("inlineCode",{parentName:"p"},"http://site1.localhost:3001/en")," will match the first site config and ",(0,a.kt)("inlineCode",{parentName:"p"},"http://site1.localhost:3001/es")," will match the second site config."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"Note"),": You must declare those locales in Next.js config. See ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/learn/advanced-features/i18n-routing"},"Next.js documentation")," for more information."),(0,a.kt)("p",null,"When using locales make sure to add the locale to ",(0,a.kt)("inlineCode",{parentName:"p"},"Settings -> General -> Headless Multisite Locale (optional)"),". This is required for previews and the revalidate handler to work properly since API routes are not localized in Next.js."),(0,a.kt)("p",null,"As an example, the first site config in the example above would need the following settings in WordPress."),(0,a.kt)("p",null,(0,a.kt)("img",{alt:"Plugin settings Multisite Locale",src:n(6078).Z,width:"759",height:"349"})),(0,a.kt)("h3",{id:"middleware"},"Middleware"),(0,a.kt)("p",null,"Make sure you have the framework's middleware setup at ",(0,a.kt)("inlineCode",{parentName:"p"},"src/middleware.js"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"import { AppMiddleware } from '@headstartwp/next/middlewares';\n\nexport const config = {\n matcher: [\n /*\n * Match all paths except for:\n * 1. /api routes\n * 2. /_next (Next.js internals)\n * 3. /fonts (inside /public)\n * 4. all root files inside /public (e.g. /favicon.ico)\n */\n '/((?!api|_next|fonts[\\\\w-]+\\\\.\\\\w+).*)',\n ],\n};\n\nexport async function middleware(...args) {\n return AppMiddleware(...args);\n}\n")),(0,a.kt)("h3",{id:"folder-structure"},"Folder structure"),(0,a.kt)("p",null,"Put all of your page routes in ",(0,a.kt)("inlineCode",{parentName:"p"},"_sites/[site]/")," folder with the exception of the following files"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"_app.js"),(0,a.kt)("li",{parentName:"ul"},"_document.js"),(0,a.kt)("li",{parentName:"ul"},"404.js"),(0,a.kt)("li",{parentName:"ul"},"500.js"),(0,a.kt)("li",{parentName:"ul"},"api/")),(0,a.kt)("p",null," This should give you a structure similar to"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"_sites/\n\u251c\u2500 [site]/\n\u2502 \u251c\u2500 [...path].js\n\u2502 \u251c\u2500 index.js\n_app.js\n_document.js\n404.js\n500.js\napi/\n")),(0,a.kt)("p",null,"With this setup, the framework's middleware will rewrite all requests to ",(0,a.kt)("inlineCode",{parentName:"p"},"_sites/hostName"),". All of the data-fetching hooks will fetch data to the appropriate WordPress instance."),(0,a.kt)("p",null,"This allows you to power all of your sites with the same codebase. This is very useful if you're building sites that support internationalization or if the only thing that changes across sites is the content."),(0,a.kt)("h3",{id:"creating-routes-that-target-a-specific-site"},"Creating Routes that target a specific site"),(0,a.kt)("p",null,"It is possible to create routes specific to each site. To do this simply create a folder for that particular site eg: ",(0,a.kt)("inlineCode",{parentName:"p"},"src/pages/_sites/mysite.com/index.js"),". Then when a user visits ",(0,a.kt)("inlineCode",{parentName:"p"},"mysite.com")," the ",(0,a.kt)("inlineCode",{parentName:"p"},"index.js")," route file will be used instead of the one in ",(0,a.kt)("inlineCode",{parentName:"p"},"[site]/index.js"),"."),(0,a.kt)("p",null,"This provides a powerful way of powering complex multi-tenant apps that shares a codebase but render completely different pages and layouts."),(0,a.kt)("h2",{id:"known-issues"},"Known Issues"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"404.js and 500.js are unable to know the current site")),(0,a.kt)("p",null,"At the moment, there's a limitation in Next.js that doesn't allow the ",(0,a.kt)("inlineCode",{parentName:"p"},"404.js")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"500.js")," pages to know the current site. These two files ",(0,a.kt)("strong",{parentName:"p"},"must")," be in the root of the pages directory and we can't rewrite them. Additionally, they only support ",(0,a.kt)("inlineCode",{parentName:"p"},"getStaticProps")," which means there's no way to know which site you're on in case you need to fetch data specific for that site."),(0,a.kt)("p",null,"If you need to fetch data in ",(0,a.kt)("inlineCode",{parentName:"p"},"404.js")," or ",(0,a.kt)("inlineCode",{parentName:"p"},"500.js")," there's one workaround but it relies on client-side data-fetching. In ",(0,a.kt)("inlineCode",{parentName:"p"},"_app.js")," do the following:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"import { getSiteByHost } from '@headstartwp/core';\n\n//grab the current site\nconst currentSite = useMemo(() => {\n if (router.query?.site && !Array.isArray(router.query.site)) {\n return getSiteByHost(router.query.site, router.locale);\n }\n\n // 404.js and 500.js do not have a site query param.\n if (typeof window !== 'undefined') {\n return getSiteByHost(window.location.host, router.locale);\n }\n return {};\n}, [router]);\n\n// pass it to HeadlessApp to override the current site settings defined by the framework\n// once react hydrates and window is defined, the currentSite will be set for 404 and 500 poages.\n\n")))}d.isMDXComponent=!0},6078:(e,t,n)=>{n.d(t,{Z:()=>r});const r=n.p+"assets/images/multisite-locale-60d679b73933b2e528aac602efd6e3d6.png"}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5148],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),p=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},u=function(e){var t=p(e.components);return r.createElement(l.Provider,{value:t},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,u=o(e,["components","mdxType","originalType","parentName"]),d=p(n),h=a,m=d["".concat(l,".").concat(h)]||d[h]||c[h]||i;return n?r.createElement(m,s(s({ref:t},u),{},{components:n})):r.createElement(m,s({ref:t},u))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,s=new Array(i);s[0]=h;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o[d]="string"==typeof e?e:a,s[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var r=n(7462),a=(n(7294),n(3905));const i={sidebar_position:1,slug:"/wordpress-integration/multisite"},s="Multisite",o={unversionedId:"WordPress Integration/multisite",id:"WordPress Integration/multisite",title:"Multisite",description:"HeadstartWP has built-in support for WordPress multisite via the sites property in the headstartwp.config.js file. This transforms the Next.js app into a multi-tenant app.",source:"@site/documentation/06-WordPress Integration/multisite.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/multisite",permalink:"/docs/learn/wordpress-integration/multisite",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/multisite.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:1,frontMatter:{sidebar_position:1,slug:"/wordpress-integration/multisite"},sidebar:"tutorialSidebar",previous:{title:"Previews",permalink:"/docs/learn/wordpress-integration/previews"},next:{title:"On-demand ISR revalidation",permalink:"/docs/learn/wordpress-integration/revalidate"}},l={},p=[{value:"Usage",id:"usage",level:2},{value:"Config",id:"config",level:3},{value:"Internationalized routing",id:"internationalized-routing",level:4},{value:"Middleware",id:"middleware",level:3},{value:"Folder structure",id:"folder-structure",level:3},{value:"Creating Routes that target a specific site",id:"creating-routes-that-target-a-specific-site",level:3},{value:"Known Issues",id:"known-issues",level:2}],u={toc:p};function d(e){let{components:t,...i}=e;return(0,a.kt)("wrapper",(0,r.Z)({},u,i,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"multisite"},"Multisite"),(0,a.kt)("p",null,"HeadstartWP has built-in support for WordPress multisite via the ",(0,a.kt)("inlineCode",{parentName:"p"},"sites")," property in the ",(0,a.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," file. This transforms the Next.js app into a multi-tenant app."),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"sites")," option allows specifying as many sites you want to connect to your app. Each site must have a ",(0,a.kt)("inlineCode",{parentName:"p"},"sourceUrl")," and a ",(0,a.kt)("inlineCode",{parentName:"p"},"hostUrl"),". The ",(0,a.kt)("inlineCode",{parentName:"p"},"hostUrl")," will be used to match the current site and ",(0,a.kt)("inlineCode",{parentName:"p"},"sourceUrl")," indicates where content should be sourced from."),(0,a.kt)("p",null,"This feature does not require that all sites belong to the same multisite, you're free to connect the Next.js app to a completely separate WordPress instance, as long as that instance implements what your Next.js app needs."),(0,a.kt)("p",null,"Take a look at the ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/tree/develop/projects/wp-multisite-nextjs"},"multisite demo project")," to familiarize yourself with the set-up."),(0,a.kt)("h2",{id:"usage"},"Usage"),(0,a.kt)("h3",{id:"config"},"Config"),(0,a.kt)("p",null,"The first step is to declare all of your sites in ",(0,a.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js"),". In the example below we're declaring two sites."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"/**\n * Headless Config\n *\n * @type {import('@headstartwp/core').HeadlessConfig}\n */\nmodule.exports = {\n redirectStrategy: '404',\n useWordPressPlugin: true,\n\n sites: [\n {\n hostUrl: 'http://site1.localhost:3001',\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n\n },\n {\n hostUrl: 'http://site2.localhost:3001',\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL_2,\n },\n ],\n};\n")),(0,a.kt)("p",null,"In the example above we specify that all sites must use the WordPress plugin and that the redirect strategy should be ",(0,a.kt)("inlineCode",{parentName:"p"},"404"),". Then we're declaring two sites that will respond via the ",(0,a.kt)("a",{parentName:"p",href:"http://site1.localhost:3001"},"http://site1.localhost:3001")," and ",(0,a.kt)("a",{parentName:"p",href:"http://site2.localhost:3001"},"http://site2.localhost:3001")," URLs. The ",(0,a.kt)("inlineCode",{parentName:"p"},"sourceUrl")," for each comes from an env variable."),(0,a.kt)("p",null,"This means that when we visit ",(0,a.kt)("a",{parentName:"p",href:"http://site1.localhost:3001"},"http://site1.localhost:3001"),", the source URL specified by ",(0,a.kt)("inlineCode",{parentName:"p"},"NEXT_PUBLIC_HEADLESS_WP_URL")," will be used."),(0,a.kt)("h4",{id:"internationalized-routing"},"Internationalized routing"),(0,a.kt)("p",null,"If you're using ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/advanced-features/i18n-routing"},"Next.js i18n")," feature you can specify the locale in the site's config object and the locale will also be used when matching a site."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"/**\n * Headless Config\n *\n * @type {import('@headstartwp/core').HeadlessConfig}\n */\nmodule.exports = {\n redirectStrategy: '404',\n useWordPressPlugin: true,\n\n sites: [\n {\n hostUrl: 'http://site1.localhost:3001',\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n locale: 'en'\n },\n {\n hostUrl: 'http://site1.localhost:3001',\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL_2,\n locale: 'es'\n },\n ],\n};\n")),(0,a.kt)("p",null,"The above config means that ",(0,a.kt)("inlineCode",{parentName:"p"},"http://site1.localhost:3001/en")," will match the first site config and ",(0,a.kt)("inlineCode",{parentName:"p"},"http://site1.localhost:3001/es")," will match the second site config."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"Note"),": You must declare those locales in Next.js config. See ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/learn/advanced-features/i18n-routing"},"Next.js documentation")," for more information."),(0,a.kt)("p",null,"When using locales make sure to add the locale to ",(0,a.kt)("inlineCode",{parentName:"p"},"Settings -> General -> Headless Multisite Locale (optional)"),". This is required for previews and the revalidate handler to work properly since API routes are not localized in Next.js."),(0,a.kt)("p",null,"As an example, the first site config in the example above would need the following settings in WordPress."),(0,a.kt)("p",null,(0,a.kt)("img",{alt:"Plugin settings Multisite Locale",src:n(6078).Z,width:"759",height:"349"})),(0,a.kt)("h3",{id:"middleware"},"Middleware"),(0,a.kt)("p",null,"Make sure you have the framework's middleware setup at ",(0,a.kt)("inlineCode",{parentName:"p"},"src/middleware.js"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"import { AppMiddleware } from '@headstartwp/next/middlewares';\n\nexport const config = {\n matcher: [\n /*\n * Match all paths except for:\n * 1. /api routes\n * 2. /_next (Next.js internals)\n * 3. /fonts (inside /public)\n * 4. all root files inside /public (e.g. /favicon.ico)\n */\n '/((?!api|_next|fonts[\\\\w-]+\\\\.\\\\w+).*)',\n ],\n};\n\nexport async function middleware(...args) {\n return AppMiddleware(...args);\n}\n")),(0,a.kt)("h3",{id:"folder-structure"},"Folder structure"),(0,a.kt)("p",null,"Put all of your page routes in ",(0,a.kt)("inlineCode",{parentName:"p"},"_sites/[site]/")," folder with the exception of the following files"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"_app.js"),(0,a.kt)("li",{parentName:"ul"},"_document.js"),(0,a.kt)("li",{parentName:"ul"},"404.js"),(0,a.kt)("li",{parentName:"ul"},"500.js"),(0,a.kt)("li",{parentName:"ul"},"api/")),(0,a.kt)("p",null," This should give you a structure similar to"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"_sites/\n\u251c\u2500 [site]/\n\u2502 \u251c\u2500 [...path].js\n\u2502 \u251c\u2500 index.js\n_app.js\n_document.js\n404.js\n500.js\napi/\n")),(0,a.kt)("p",null,"With this setup, the framework's middleware will rewrite all requests to ",(0,a.kt)("inlineCode",{parentName:"p"},"_sites/hostName"),". All of the data-fetching hooks will fetch data to the appropriate WordPress instance."),(0,a.kt)("p",null,"This allows you to power all of your sites with the same codebase. This is very useful if you're building sites that support internationalization or if the only thing that changes across sites is the content."),(0,a.kt)("h3",{id:"creating-routes-that-target-a-specific-site"},"Creating Routes that target a specific site"),(0,a.kt)("p",null,"It is possible to create routes specific to each site. To do this simply create a folder for that particular site eg: ",(0,a.kt)("inlineCode",{parentName:"p"},"src/pages/_sites/mysite.com/index.js"),". Then when a user visits ",(0,a.kt)("inlineCode",{parentName:"p"},"mysite.com")," the ",(0,a.kt)("inlineCode",{parentName:"p"},"index.js")," route file will be used instead of the one in ",(0,a.kt)("inlineCode",{parentName:"p"},"[site]/index.js"),"."),(0,a.kt)("p",null,"This provides a powerful way of powering complex multi-tenant apps that shares a codebase but render completely different pages and layouts."),(0,a.kt)("h2",{id:"known-issues"},"Known Issues"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"404.js and 500.js are unable to know the current site")),(0,a.kt)("p",null,"At the moment, there's a limitation in Next.js that doesn't allow the ",(0,a.kt)("inlineCode",{parentName:"p"},"404.js")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"500.js")," pages to know the current site. These two files ",(0,a.kt)("strong",{parentName:"p"},"must")," be in the root of the pages directory and we can't rewrite them. Additionally, they only support ",(0,a.kt)("inlineCode",{parentName:"p"},"getStaticProps")," which means there's no way to know which site you're on in case you need to fetch data specific for that site."),(0,a.kt)("p",null,"If you need to fetch data in ",(0,a.kt)("inlineCode",{parentName:"p"},"404.js")," or ",(0,a.kt)("inlineCode",{parentName:"p"},"500.js")," there's one workaround but it relies on client-side data-fetching. In ",(0,a.kt)("inlineCode",{parentName:"p"},"_app.js")," do the following:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"import { getSiteByHost } from '@headstartwp/core';\n\n//grab the current site\nconst currentSite = useMemo(() => {\n if (router.query?.site && !Array.isArray(router.query.site)) {\n return getSiteByHost(router.query.site, router.locale);\n }\n\n // 404.js and 500.js do not have a site query param.\n if (typeof window !== 'undefined') {\n return getSiteByHost(window.location.host, router.locale);\n }\n return {};\n}, [router]);\n\n// pass it to HeadlessApp to override the current site settings defined by the framework\n// once react hydrates and window is defined, the currentSite will be set for 404 and 500 poages.\n\n")))}d.isMDXComponent=!0},6078:(e,t,n)=>{n.d(t,{Z:()=>r});const r=n.p+"assets/images/multisite-locale-60d679b73933b2e528aac602efd6e3d6.png"}}]); \ No newline at end of file diff --git a/assets/js/d9995696.8d6e61fc.js b/assets/js/d9995696.fcc0b3ba.js similarity index 98% rename from assets/js/d9995696.8d6e61fc.js rename to assets/js/d9995696.fcc0b3ba.js index 2a44e4201..dd40f80df 100644 --- a/assets/js/d9995696.8d6e61fc.js +++ b/assets/js/d9995696.fcc0b3ba.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5234],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),l=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},s=function(e){var t=l(e.components);return n.createElement(p.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,p=e.parentName,s=c(e,["components","mdxType","originalType","parentName"]),d=l(r),f=a,m=d["".concat(p,".").concat(f)]||d[f]||u[f]||o;return r?n.createElement(m,i(i({ref:t},s),{},{components:r})):n.createElement(m,i({ref:t},s))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=f;var c={};for(var p in t)hasOwnProperty.call(t,p)&&(c[p]=t[p]);c.originalType=e,c[d]="string"==typeof e?e:a,i[1]=c;for(var l=2;l{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var n=r(7462),a=(r(7294),r(3905));const o={id:"headstartwp_core.Integration",title:"Interface: Integration",sidebar_label:"@headstartwp/core.Integration",custom_edit_url:null},i=void 0,c={unversionedId:"interfaces/headstartwp_core.Integration",id:"interfaces/headstartwp_core.Integration",title:"Interface: Integration",description:"@headstartwp/core.Integration",source:"@site/docs/interfaces/headstartwp_core.Integration.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.Integration",permalink:"/docs/api/interfaces/headstartwp_core.Integration",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.Integration",title:"Interface: Integration",sidebar_label:"@headstartwp/core.Integration",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.HTMLReactParserOptions",permalink:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"},next:{title:"@headstartwp/core.MenuItemEntity",permalink:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"enable",id:"enable",level:3},{value:"Defined in",id:"defined-in",level:4}],s={toc:l};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".Integration"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Integration"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration"},(0,a.kt)("inlineCode",{parentName:"a"},"YoastSEOIntegration"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PolylangIntegration"},(0,a.kt)("inlineCode",{parentName:"a"},"PolylangIntegration"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"enable"},"enable"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"enable"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/types.ts#L46"},"packages/core/src/types.ts:46")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5234],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),l=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},s=function(e){var t=l(e.components);return n.createElement(p.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,p=e.parentName,s=c(e,["components","mdxType","originalType","parentName"]),d=l(r),f=a,m=d["".concat(p,".").concat(f)]||d[f]||u[f]||o;return r?n.createElement(m,i(i({ref:t},s),{},{components:r})):n.createElement(m,i({ref:t},s))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=f;var c={};for(var p in t)hasOwnProperty.call(t,p)&&(c[p]=t[p]);c.originalType=e,c[d]="string"==typeof e?e:a,i[1]=c;for(var l=2;l{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var n=r(7462),a=(r(7294),r(3905));const o={id:"headstartwp_core.Integration",title:"Interface: Integration",sidebar_label:"@headstartwp/core.Integration",custom_edit_url:null},i=void 0,c={unversionedId:"interfaces/headstartwp_core.Integration",id:"interfaces/headstartwp_core.Integration",title:"Interface: Integration",description:"@headstartwp/core.Integration",source:"@site/docs/interfaces/headstartwp_core.Integration.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.Integration",permalink:"/docs/api/interfaces/headstartwp_core.Integration",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.Integration",title:"Interface: Integration",sidebar_label:"@headstartwp/core.Integration",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.HTMLReactParserOptions",permalink:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"},next:{title:"@headstartwp/core.MenuItemEntity",permalink:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"enable",id:"enable",level:3},{value:"Defined in",id:"defined-in",level:4}],s={toc:l};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".Integration"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Integration"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration"},(0,a.kt)("inlineCode",{parentName:"a"},"YoastSEOIntegration"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PolylangIntegration"},(0,a.kt)("inlineCode",{parentName:"a"},"PolylangIntegration"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"enable"},"enable"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"enable"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/types.ts#L46"},"packages/core/src/types.ts:46")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d9f3c1c7.6ff3e65b.js b/assets/js/d9f3c1c7.11627e4f.js similarity index 97% rename from assets/js/d9f3c1c7.6ff3e65b.js rename to assets/js/d9f3c1c7.11627e4f.js index fe2803702..26d1c8d57 100644 --- a/assets/js/d9f3c1c7.6ff3e65b.js +++ b/assets/js/d9f3c1c7.11627e4f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[62],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var l=a.createContext({}),p=function(e){var t=a.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},c=function(e){var t=p(e.components);return a.createElement(l.Provider,{value:t},e.children)},d="mdxType",f={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=p(r),u=n,h=d["".concat(l,".").concat(u)]||d[u]||f[u]||i;return r?a.createElement(h,o(o({ref:t},c),{},{components:r})):a.createElement(h,o({ref:t},c))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=u;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[d]="string"==typeof e?e:n,o[1]=s;for(var p=2;p{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.FilterDataOptions",title:"Interface: FilterDataOptions",sidebar_label:"@headstartwp/core.FilterDataOptions",custom_edit_url:null},o=void 0,s={unversionedId:"interfaces/headstartwp_core.FilterDataOptions",id:"interfaces/headstartwp_core.FilterDataOptions",title:"Interface: FilterDataOptions",description:"@headstartwp/core.FilterDataOptions",source:"@site/docs/interfaces/headstartwp_core.FilterDataOptions.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.FilterDataOptions",permalink:"/docs/api/interfaces/headstartwp_core.FilterDataOptions",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.FilterDataOptions",title:"Interface: FilterDataOptions",sidebar_label:"@headstartwp/core.FilterDataOptions",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.FetchResponse",permalink:"/docs/api/interfaces/headstartwp_core.FetchResponse"},next:{title:"@headstartwp/core.HTMLReactParserOptions",permalink:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"}},l={},p=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"fields",id:"fields",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"method",id:"method",level:3},{value:"Defined in",id:"defined-in-1",level:4}],c={toc:p};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".FilterDataOptions"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"fields"},"fields"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"fields"),": keyof ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L80"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:80")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"method"},"method"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"method"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"ALLOW"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"REMOVE"')),(0,n.kt)("p",null,"If method is 'ALLOW' then only the fields specified in the filter will be returned.\nIf method is 'REMOVE' then the fields specified in the filter will be removed."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L79"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:79")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[62],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var l=a.createContext({}),p=function(e){var t=a.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},c=function(e){var t=p(e.components);return a.createElement(l.Provider,{value:t},e.children)},d="mdxType",f={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=p(r),u=n,h=d["".concat(l,".").concat(u)]||d[u]||f[u]||i;return r?a.createElement(h,o(o({ref:t},c),{},{components:r})):a.createElement(h,o({ref:t},c))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=u;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[d]="string"==typeof e?e:n,o[1]=s;for(var p=2;p{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.FilterDataOptions",title:"Interface: FilterDataOptions",sidebar_label:"@headstartwp/core.FilterDataOptions",custom_edit_url:null},o=void 0,s={unversionedId:"interfaces/headstartwp_core.FilterDataOptions",id:"interfaces/headstartwp_core.FilterDataOptions",title:"Interface: FilterDataOptions",description:"@headstartwp/core.FilterDataOptions",source:"@site/docs/interfaces/headstartwp_core.FilterDataOptions.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.FilterDataOptions",permalink:"/docs/api/interfaces/headstartwp_core.FilterDataOptions",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.FilterDataOptions",title:"Interface: FilterDataOptions",sidebar_label:"@headstartwp/core.FilterDataOptions",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.FetchResponse",permalink:"/docs/api/interfaces/headstartwp_core.FetchResponse"},next:{title:"@headstartwp/core.HTMLReactParserOptions",permalink:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"}},l={},p=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"fields",id:"fields",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"method",id:"method",level:3},{value:"Defined in",id:"defined-in-1",level:4}],c={toc:p};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".FilterDataOptions"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"fields"},"fields"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"fields"),": keyof ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L80"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:80")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"method"},"method"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"method"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"ALLOW"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"REMOVE"')),(0,n.kt)("p",null,"If method is 'ALLOW' then only the fields specified in the filter will be returned.\nIf method is 'REMOVE' then the fields specified in the filter will be removed."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L79"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:79")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/dcac5d89.be7d4547.js b/assets/js/dcac5d89.98136835.js similarity index 98% rename from assets/js/dcac5d89.be7d4547.js rename to assets/js/dcac5d89.98136835.js index 03074fee9..a2d111b50 100644 --- a/assets/js/dcac5d89.be7d4547.js +++ b/assets/js/dcac5d89.98136835.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7137],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>u});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var s=n.createContext({}),l=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},c=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},d="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},y=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),d=l(a),y=r,u=d["".concat(s,".").concat(y)]||d[y]||m[y]||i;return a?n.createElement(u,p(p({ref:t},c),{},{components:a})):n.createElement(u,p({ref:t},c))}));function u(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=y;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[d]="string"==typeof e?e:r,p[1]=o;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.Entity",title:"Interface: Entity",sidebar_label:"@headstartwp/core.Entity",custom_edit_url:null},p=void 0,o={unversionedId:"interfaces/headstartwp_core.Entity",id:"interfaces/headstartwp_core.Entity",title:"Interface: Entity",description:"@headstartwp/core.Entity",source:"@site/docs/interfaces/headstartwp_core.Entity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.Entity",permalink:"/docs/api/interfaces/headstartwp_core.Entity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.Entity",title:"Interface: Entity",sidebar_label:"@headstartwp/core.Entity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.EndpointParams",permalink:"/docs/api/interfaces/headstartwp_core.EndpointParams"},next:{title:"@headstartwp/core.FetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.FetchOptions"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"yoast_head",id:"yoast_head",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Defined in",id:"defined-in-1",level:4}],c={toc:l};function d(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".Entity"),(0,r.kt)("p",null,"Empty interface from which all entities inherit."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostTypeEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TypeEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TypeEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TaxonomyEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TaxonomyEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.CommentEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"CommentEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"SearchEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AppEntity"))))),(0,r.kt)("h2",{id:"indexable"},"Indexable"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7137],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>u});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var s=n.createContext({}),l=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},c=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},d="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},y=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),d=l(a),y=r,u=d["".concat(s,".").concat(y)]||d[y]||m[y]||i;return a?n.createElement(u,p(p({ref:t},c),{},{components:a})):n.createElement(u,p({ref:t},c))}));function u(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=y;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[d]="string"==typeof e?e:r,p[1]=o;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.Entity",title:"Interface: Entity",sidebar_label:"@headstartwp/core.Entity",custom_edit_url:null},p=void 0,o={unversionedId:"interfaces/headstartwp_core.Entity",id:"interfaces/headstartwp_core.Entity",title:"Interface: Entity",description:"@headstartwp/core.Entity",source:"@site/docs/interfaces/headstartwp_core.Entity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.Entity",permalink:"/docs/api/interfaces/headstartwp_core.Entity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.Entity",title:"Interface: Entity",sidebar_label:"@headstartwp/core.Entity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.EndpointParams",permalink:"/docs/api/interfaces/headstartwp_core.EndpointParams"},next:{title:"@headstartwp/core.FetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.FetchOptions"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"yoast_head",id:"yoast_head",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Defined in",id:"defined-in-1",level:4}],c={toc:l};function d(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".Entity"),(0,r.kt)("p",null,"Empty interface from which all entities inherit."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostTypeEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TypeEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TypeEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TaxonomyEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TaxonomyEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.CommentEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"CommentEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"SearchEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AppEntity"))))),(0,r.kt)("h2",{id:"indexable"},"Indexable"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/def27140.adb6d360.js b/assets/js/def27140.fa9c7526.js similarity index 97% rename from assets/js/def27140.adb6d360.js rename to assets/js/def27140.fa9c7526.js index 009b51fe4..b5ba90edf 100644 --- a/assets/js/def27140.adb6d360.js +++ b/assets/js/def27140.fa9c7526.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5593],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function o(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,o(o({ref:t},d),{},{components:a})):r.createElement(h,o({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,o=new Array(l);o[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,o[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>l,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.IPullQuoteBlock",title:"Interface: IPullQuoteBlock",sidebar_label:"@headstartwp/core.react.IPullQuoteBlock",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IPullQuoteBlock",id:"interfaces/headstartwp_core.react.IPullQuoteBlock",title:"Interface: IPullQuoteBlock",description:"@headstartwp/core.react.IPullQuoteBlock",source:"@site/docs/interfaces/headstartwp_core.react.IPullQuoteBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IPullQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IPullQuoteBlock",title:"Interface: IPullQuoteBlock",sidebar_label:"@headstartwp/core.react.IPullQuoteBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IPreformattedBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock"},next:{title:"@headstartwp/core.react.IQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IPullQuoteBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PullQuoteBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IPullQuoteBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PullQuoteBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PullQuoteBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5593],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function o(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,o(o({ref:t},d),{},{components:a})):r.createElement(h,o({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,o=new Array(l);o[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,o[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>l,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.IPullQuoteBlock",title:"Interface: IPullQuoteBlock",sidebar_label:"@headstartwp/core.react.IPullQuoteBlock",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IPullQuoteBlock",id:"interfaces/headstartwp_core.react.IPullQuoteBlock",title:"Interface: IPullQuoteBlock",description:"@headstartwp/core.react.IPullQuoteBlock",source:"@site/docs/interfaces/headstartwp_core.react.IPullQuoteBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IPullQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IPullQuoteBlock",title:"Interface: IPullQuoteBlock",sidebar_label:"@headstartwp/core.react.IPullQuoteBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IPreformattedBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock"},next:{title:"@headstartwp/core.react.IQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IPullQuoteBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PullQuoteBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IPullQuoteBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PullQuoteBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PullQuoteBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e088eb77.e0b0e568.js b/assets/js/e088eb77.eaf95347.js similarity index 96% rename from assets/js/e088eb77.e0b0e568.js rename to assets/js/e088eb77.eaf95347.js index b50b59ae1..ea1a8cae5 100644 --- a/assets/js/e088eb77.e0b0e568.js +++ b/assets/js/e088eb77.eaf95347.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8089],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.IVerseBlock",title:"Interface: IVerseBlock",sidebar_label:"@headstartwp/core.react.IVerseBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IVerseBlock",id:"interfaces/headstartwp_core.react.IVerseBlock",title:"Interface: IVerseBlock",description:"@headstartwp/core.react.IVerseBlock",source:"@site/docs/interfaces/headstartwp_core.react.IVerseBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IVerseBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IVerseBlock",title:"Interface: IVerseBlock",sidebar_label:"@headstartwp/core.react.IVerseBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ITableBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ITableBlock"},next:{title:"@headstartwp/core.react.IYoutubeLiteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IVerseBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"VerseBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IVerseBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"VerseBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"VerseBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8089],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.IVerseBlock",title:"Interface: IVerseBlock",sidebar_label:"@headstartwp/core.react.IVerseBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IVerseBlock",id:"interfaces/headstartwp_core.react.IVerseBlock",title:"Interface: IVerseBlock",description:"@headstartwp/core.react.IVerseBlock",source:"@site/docs/interfaces/headstartwp_core.react.IVerseBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IVerseBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IVerseBlock",title:"Interface: IVerseBlock",sidebar_label:"@headstartwp/core.react.IVerseBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ITableBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ITableBlock"},next:{title:"@headstartwp/core.react.IYoutubeLiteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IVerseBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"VerseBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IVerseBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"VerseBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"VerseBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e4594716.a1646846.js b/assets/js/e4594716.4c67810e.js similarity index 97% rename from assets/js/e4594716.a1646846.js rename to assets/js/e4594716.4c67810e.js index 23ab1a3e5..b41349785 100644 --- a/assets/js/e4594716.a1646846.js +++ b/assets/js/e4594716.4c67810e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6623],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var l=r.createContext({}),d=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return r.createElement(l.Provider,{value:t},e.children)},m="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),m=d(a),k=n,h=m["".concat(l,".").concat(k)]||m[k]||c[k]||i;return a?r.createElement(h,p(p({ref:t},o),{},{components:a})):r.createElement(h,p({ref:t},o))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=k;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[m]="string"==typeof e?e:n,p[1]=s;for(var d=2;d{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>m,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.PostOrPostsFetchStrategy",title:"Class: PostOrPostsFetchStrategy",sidebar_label:"@headstartwp/core.PostOrPostsFetchStrategy",custom_edit_url:null},p=void 0,s={unversionedId:"classes/headstartwp_core.PostOrPostsFetchStrategy",id:"classes/headstartwp_core.PostOrPostsFetchStrategy",title:"Class: PostOrPostsFetchStrategy",description:"@headstartwp/core.PostOrPostsFetchStrategy",source:"@site/docs/classes/headstartwp_core.PostOrPostsFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.PostOrPostsFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostOrPostsFetchStrategy",title:"Class: PostOrPostsFetchStrategy",sidebar_label:"@headstartwp/core.PostOrPostsFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.NotFoundError",permalink:"/docs/api/classes/headstartwp_core.NotFoundError"},next:{title:"@headstartwp/core.PostsArchiveFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"}},l={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"postStrategy",id:"poststrategy",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"postsStrategy",id:"postsstrategy",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"urlParams",id:"urlparams",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"fetchArchive",id:"fetcharchive",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"fetchSingle",id:"fetchsingle",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-24",level:4}],o={toc:d};function m(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostOrPostsFetchStrategy"),(0,n.kt)("p",null,"This fetch strategy does not support extracting url params from the url"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"R")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#postorpostsfetchstrategyresult"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategyResult")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#postorpostsfetchstrategyresult"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategyResult")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PostOrPostsFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new PostOrPostsFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"R")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#postorpostsfetchstrategyresult"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategyResult")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#postorpostsfetchstrategyresult"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategyResult")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L115"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:115")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L105"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:105")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L110"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:110")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"poststrategy"},"postStrategy"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"postStrategy"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"SinglePostFetchStrategy")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams")),">"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L60"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:60")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"postsstrategy"},"postsStrategy"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"postsStrategy"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveFetchStrategy")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")),">"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L62"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:62")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"urlparams"},"urlParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"urlParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L58"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:58")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Builds the final endpoint URL based on the passed parameters"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to add to the request")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The endpoint URL."),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L206"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:206")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcharchive"},"fetchArchive"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetchArchive"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"R")," }",">"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"R")," }",">"),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L145"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:145")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetchsingle"},"fetchSingle"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetchSingle"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"R")," }",">"),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"R")," }",">"),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L132"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:132")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("p",null,"The default fetcher function"),(0,n.kt)("p",null,"The default fetcher function handles authentication headers and errors from the API."),(0,n.kt)("p",null,"A custom strategy can override this function to run additional logic before or after the fetch call"),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetcher options")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L158"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:158")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L339"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:339")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L404"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:404")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L227"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:227")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L369"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:369")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L64"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:64")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L168"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:168")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L68"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:68")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L327"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L191"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:191")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-3"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L77"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L219"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:219")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L150"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:150")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-15"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-17"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L146"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:146")))}m.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6623],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var l=r.createContext({}),d=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return r.createElement(l.Provider,{value:t},e.children)},m="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),m=d(a),k=n,h=m["".concat(l,".").concat(k)]||m[k]||c[k]||i;return a?r.createElement(h,p(p({ref:t},o),{},{components:a})):r.createElement(h,p({ref:t},o))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=k;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[m]="string"==typeof e?e:n,p[1]=s;for(var d=2;d{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>m,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.PostOrPostsFetchStrategy",title:"Class: PostOrPostsFetchStrategy",sidebar_label:"@headstartwp/core.PostOrPostsFetchStrategy",custom_edit_url:null},p=void 0,s={unversionedId:"classes/headstartwp_core.PostOrPostsFetchStrategy",id:"classes/headstartwp_core.PostOrPostsFetchStrategy",title:"Class: PostOrPostsFetchStrategy",description:"@headstartwp/core.PostOrPostsFetchStrategy",source:"@site/docs/classes/headstartwp_core.PostOrPostsFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.PostOrPostsFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostOrPostsFetchStrategy",title:"Class: PostOrPostsFetchStrategy",sidebar_label:"@headstartwp/core.PostOrPostsFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.NotFoundError",permalink:"/docs/api/classes/headstartwp_core.NotFoundError"},next:{title:"@headstartwp/core.PostsArchiveFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"}},l={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"postStrategy",id:"poststrategy",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"postsStrategy",id:"postsstrategy",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"urlParams",id:"urlparams",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"fetchArchive",id:"fetcharchive",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"fetchSingle",id:"fetchsingle",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-24",level:4}],o={toc:d};function m(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostOrPostsFetchStrategy"),(0,n.kt)("p",null,"This fetch strategy does not support extracting url params from the url"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"R")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#postorpostsfetchstrategyresult"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategyResult")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#postorpostsfetchstrategyresult"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategyResult")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PostOrPostsFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new PostOrPostsFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"R")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#postorpostsfetchstrategyresult"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategyResult")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#postorpostsfetchstrategyresult"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategyResult")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L115"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:115")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L105"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:105")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L110"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:110")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"poststrategy"},"postStrategy"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"postStrategy"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"SinglePostFetchStrategy")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams")),">"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L60"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:60")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"postsstrategy"},"postsStrategy"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"postsStrategy"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveFetchStrategy")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")),">"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L62"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:62")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"urlparams"},"urlParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"urlParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L58"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:58")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Builds the final endpoint URL based on the passed parameters"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to add to the request")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The endpoint URL."),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L206"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:206")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcharchive"},"fetchArchive"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetchArchive"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"R")," }",">"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"R")," }",">"),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L145"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:145")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetchsingle"},"fetchSingle"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetchSingle"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"R")," }",">"),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"R")," }",">"),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L132"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:132")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("p",null,"The default fetcher function"),(0,n.kt)("p",null,"The default fetcher function handles authentication headers and errors from the API."),(0,n.kt)("p",null,"A custom strategy can override this function to run additional logic before or after the fetch call"),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetcher options")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L158"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:158")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L339"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:339")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L404"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:404")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L227"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:227")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L369"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:369")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L64"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:64")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L168"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:168")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L68"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:68")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L327"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L191"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:191")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-3"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L77"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L219"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:219")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L150"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:150")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-15"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-17"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L146"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:146")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e518cb64.bbe73901.js b/assets/js/e518cb64.7e65a878.js similarity index 97% rename from assets/js/e518cb64.bbe73901.js rename to assets/js/e518cb64.7e65a878.js index 201e6cac4..2727ab181 100644 --- a/assets/js/e518cb64.bbe73901.js +++ b/assets/js/e518cb64.7e65a878.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[984],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),c=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=r,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?n.createElement(h,l(l({ref:t},d),{},{components:a})):n.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:r,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var n=a(7462),r=(a(7294),a(3905));const o={id:"headstartwp_core.react.IButtonBlock",title:"Interface: IButtonBlock",sidebar_label:"@headstartwp/core.react.IButtonBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IButtonBlock",id:"interfaces/headstartwp_core.react.IButtonBlock",title:"Interface: IButtonBlock",description:"@headstartwp/core.react.IButtonBlock",source:"@site/docs/interfaces/headstartwp_core.react.IButtonBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IButtonBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IButtonBlock",title:"Interface: IButtonBlock",sidebar_label:"@headstartwp/core.react.IButtonBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IBlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},next:{title:"@headstartwp/core.react.IButtonsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IButtonBlock"),(0,r.kt)("p",null,"The common interface for a block transform component"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonBlockProps")),">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IButtonBlock"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classname"},"className"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"component"},"component"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"component"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonBlockProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonBlockProps")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[984],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),c=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=r,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?n.createElement(h,l(l({ref:t},d),{},{components:a})):n.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:r,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var n=a(7462),r=(a(7294),a(3905));const o={id:"headstartwp_core.react.IButtonBlock",title:"Interface: IButtonBlock",sidebar_label:"@headstartwp/core.react.IButtonBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IButtonBlock",id:"interfaces/headstartwp_core.react.IButtonBlock",title:"Interface: IButtonBlock",description:"@headstartwp/core.react.IButtonBlock",source:"@site/docs/interfaces/headstartwp_core.react.IButtonBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IButtonBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IButtonBlock",title:"Interface: IButtonBlock",sidebar_label:"@headstartwp/core.react.IButtonBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IBlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},next:{title:"@headstartwp/core.react.IButtonsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IButtonBlock"),(0,r.kt)("p",null,"The common interface for a block transform component"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonBlockProps")),">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IButtonBlock"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classname"},"className"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"component"},"component"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"component"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonBlockProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonBlockProps")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/eb775807.9566d6f1.js b/assets/js/eb775807.a1a3e3cc.js similarity index 93% rename from assets/js/eb775807.9566d6f1.js rename to assets/js/eb775807.a1a3e3cc.js index cfa2d4f9a..b2f7edb52 100644 --- a/assets/js/eb775807.9566d6f1.js +++ b/assets/js/eb775807.a1a3e3cc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8743],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function p(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var i=a.createContext({}),c=function(e){var t=a.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},l=function(e){var t=c(e.components);return a.createElement(i.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,p=e.originalType,i=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),d=c(r),h=n,f=d["".concat(i,".").concat(h)]||d[h]||u[h]||p;return r?a.createElement(f,o(o({ref:t},l),{},{components:r})):a.createElement(f,o({ref:t},l))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var p=r.length,o=new Array(p);o[0]=h;var s={};for(var i in t)hasOwnProperty.call(t,i)&&(s[i]=t[i]);s.originalType=e,s[d]="string"==typeof e?e:n,o[1]=s;for(var c=2;c{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>d,frontMatter:()=>p,metadata:()=>s,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const p={id:"headstartwp_core.react.useAppSettingsResponse",title:"Interface: useAppSettingsResponse",sidebar_label:"@headstartwp/core.react.useAppSettingsResponse",custom_edit_url:null},o=void 0,s={unversionedId:"interfaces/headstartwp_core.react.useAppSettingsResponse",id:"interfaces/headstartwp_core.react.useAppSettingsResponse",title:"Interface: useAppSettingsResponse",description:"@headstartwp/core.react.useAppSettingsResponse",source:"@site/docs/interfaces/headstartwp_core.react.useAppSettingsResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.useAppSettingsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.useAppSettingsResponse",title:"Interface: useAppSettingsResponse",sidebar_label:"@headstartwp/core.react.useAppSettingsResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.YoutubeLiteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},next:{title:"@headstartwp/core.react.useFetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.useFetchOptions"}},i={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],l={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".useAppSettingsResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"useAppSettingsResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T")),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/useFetchAppSettings.ts#L8"},"packages/core/src/react/hooks/useFetchAppSettings.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8743],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>k});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function p(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var i=a.createContext({}),c=function(e){var t=a.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},l=function(e){var t=c(e.components);return a.createElement(i.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,p=e.originalType,i=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),d=c(r),h=n,k=d["".concat(i,".").concat(h)]||d[h]||u[h]||p;return r?a.createElement(k,o(o({ref:t},l),{},{components:r})):a.createElement(k,o({ref:t},l))}));function k(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var p=r.length,o=new Array(p);o[0]=h;var s={};for(var i in t)hasOwnProperty.call(t,i)&&(s[i]=t[i]);s.originalType=e,s[d]="string"==typeof e?e:n,o[1]=s;for(var c=2;c{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>d,frontMatter:()=>p,metadata:()=>s,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const p={id:"headstartwp_core.react.useAppSettingsResponse",title:"Interface: useAppSettingsResponse",sidebar_label:"@headstartwp/core.react.useAppSettingsResponse",custom_edit_url:null},o=void 0,s={unversionedId:"interfaces/headstartwp_core.react.useAppSettingsResponse",id:"interfaces/headstartwp_core.react.useAppSettingsResponse",title:"Interface: useAppSettingsResponse",description:"@headstartwp/core.react.useAppSettingsResponse",source:"@site/docs/interfaces/headstartwp_core.react.useAppSettingsResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.useAppSettingsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.useAppSettingsResponse",title:"Interface: useAppSettingsResponse",sidebar_label:"@headstartwp/core.react.useAppSettingsResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.YoutubeLiteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},next:{title:"@headstartwp/core.react.useFetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.useFetchOptions"}},i={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],l={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".useAppSettingsResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"useAppSettingsResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T")),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/useFetchAppSettings.ts#L8"},"packages/core/src/react/hooks/useFetchAppSettings.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ecbd967a.1ccf8935.js b/assets/js/ecbd967a.fc7951f6.js similarity index 98% rename from assets/js/ecbd967a.1ccf8935.js rename to assets/js/ecbd967a.fc7951f6.js index 398353595..160857f6d 100644 --- a/assets/js/ecbd967a.1ccf8935.js +++ b/assets/js/ecbd967a.fc7951f6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6307],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>m});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=n.createContext({}),u=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},d=function(e){var t=u(e.components);return n.createElement(l.Provider,{value:t},e.children)},s="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,d=c(e,["components","mdxType","originalType","parentName"]),s=u(r),f=o,m=s["".concat(l,".").concat(f)]||s[f]||p[f]||a;return r?n.createElement(m,i(i({ref:t},d),{},{components:r})):n.createElement(m,i({ref:t},d))}));function m(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,i=new Array(a);i[0]=f;var c={};for(var l in t)hasOwnProperty.call(t,l)&&(c[l]=t[l]);c.originalType=e,c[s]="string"==typeof e?e:o,i[1]=c;for(var u=2;u{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>s,frontMatter:()=>a,metadata:()=>c,toc:()=>u});var n=r(7462),o=(r(7294),r(3905));const a={sidebar_position:0,sidebar_label:"Introduction"},i="Introduction",c={unversionedId:"index",id:"index",title:"Introduction",description:"Welcome to HeadstartWP documentation site! If you are new, we highly recommend reading all the way through Getting Started first.",source:"@site/documentation/index.md",sourceDirName:".",slug:"/",permalink:"/docs/learn/",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/index.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:0,frontMatter:{sidebar_position:0,sidebar_label:"Introduction"},sidebar:"tutorialSidebar",next:{title:"Quick Setup",permalink:"/docs/learn/getting-started/quick-setup"}},l={},u=[],d={toc:u};function s(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"introduction"},"Introduction"),(0,o.kt)("p",null,"Welcome to HeadstartWP documentation site! If you are new, we highly recommend reading all the way through ",(0,o.kt)("a",{parentName:"p",href:"/learn/getting-started/quick-setup/"},"Getting Started")," first."))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6307],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>m});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=n.createContext({}),u=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},d=function(e){var t=u(e.components);return n.createElement(l.Provider,{value:t},e.children)},s="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,d=c(e,["components","mdxType","originalType","parentName"]),s=u(r),f=o,m=s["".concat(l,".").concat(f)]||s[f]||p[f]||a;return r?n.createElement(m,i(i({ref:t},d),{},{components:r})):n.createElement(m,i({ref:t},d))}));function m(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,i=new Array(a);i[0]=f;var c={};for(var l in t)hasOwnProperty.call(t,l)&&(c[l]=t[l]);c.originalType=e,c[s]="string"==typeof e?e:o,i[1]=c;for(var u=2;u{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>s,frontMatter:()=>a,metadata:()=>c,toc:()=>u});var n=r(7462),o=(r(7294),r(3905));const a={sidebar_position:0,sidebar_label:"Introduction"},i="Introduction",c={unversionedId:"index",id:"index",title:"Introduction",description:"Welcome to HeadstartWP documentation site! If you are new, we highly recommend reading all the way through Getting Started first.",source:"@site/documentation/index.md",sourceDirName:".",slug:"/",permalink:"/docs/learn/",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/index.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:0,frontMatter:{sidebar_position:0,sidebar_label:"Introduction"},sidebar:"tutorialSidebar",next:{title:"Quick Setup",permalink:"/docs/learn/getting-started/quick-setup"}},l={},u=[],d={toc:u};function s(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"introduction"},"Introduction"),(0,o.kt)("p",null,"Welcome to HeadstartWP documentation site! If you are new, we highly recommend reading all the way through ",(0,o.kt)("a",{parentName:"p",href:"/learn/getting-started/quick-setup/"},"Getting Started")," first."))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ef311a1f.c4545799.js b/assets/js/ef311a1f.b9b0ba11.js similarity index 89% rename from assets/js/ef311a1f.c4545799.js rename to assets/js/ef311a1f.b9b0ba11.js index 101f00780..c6932b464 100644 --- a/assets/js/ef311a1f.c4545799.js +++ b/assets/js/ef311a1f.b9b0ba11.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5278],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function s(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),l=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},c=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,s=e.originalType,p=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),d=l(r),u=n,h=d["".concat(p,".").concat(u)]||d[u]||k[u]||s;return r?a.createElement(h,o(o({ref:t},c),{},{components:r})):a.createElement(h,o({ref:t},c))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var s=r.length,o=new Array(s);o[0]=u;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[d]="string"==typeof e?e:n,o[1]=i;for(var l=2;l{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>d,frontMatter:()=>s,metadata:()=>i,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const s={id:"headstartwp_core.react.usePostOrPostResponse",title:"Interface: usePostOrPostResponse",sidebar_label:"@headstartwp/core.react.usePostOrPostResponse",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.usePostOrPostResponse",id:"interfaces/headstartwp_core.react.usePostOrPostResponse",title:"Interface: usePostOrPostResponse",description:"@headstartwp/core.react.usePostOrPostResponse",source:"@site/docs/interfaces/headstartwp_core.react.usePostOrPostResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.usePostOrPostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.usePostOrPostResponse",title:"Interface: usePostOrPostResponse",sidebar_label:"@headstartwp/core.react.usePostOrPostResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.useMenuResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"},next:{title:"@headstartwp/core.react.usePostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"}},p={},l=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isArchive",id:"isarchive",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isSingle",id:"issingle",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-5",level:4}],c={toc:l};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".usePostOrPostResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"usePostOrPostResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"post?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"posts?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]")))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/useFetchPostOrPosts.ts#L15"},"packages/core/src/react/hooks/useFetchPostOrPosts.ts:15")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"isarchive"},"isArchive"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isArchive"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/useFetchPostOrPosts.ts#L17"},"packages/core/src/react/hooks/useFetchPostOrPosts.ts:17")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"issingle"},"isSingle"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isSingle"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/useFetchPostOrPosts.ts#L16"},"packages/core/src/react/hooks/useFetchPostOrPosts.ts:16")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5278],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function s(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),l=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},d=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,s=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),c=l(r),u=n,h=c["".concat(p,".").concat(u)]||c[u]||k[u]||s;return r?a.createElement(h,o(o({ref:t},d),{},{components:r})):a.createElement(h,o({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var s=r.length,o=new Array(s);o[0]=u;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[c]="string"==typeof e?e:n,o[1]=i;for(var l=2;l{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>c,frontMatter:()=>s,metadata:()=>i,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const s={id:"headstartwp_core.react.usePostOrPostResponse",title:"Interface: usePostOrPostResponse",sidebar_label:"@headstartwp/core.react.usePostOrPostResponse",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.usePostOrPostResponse",id:"interfaces/headstartwp_core.react.usePostOrPostResponse",title:"Interface: usePostOrPostResponse",description:"@headstartwp/core.react.usePostOrPostResponse",source:"@site/docs/interfaces/headstartwp_core.react.usePostOrPostResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.usePostOrPostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.usePostOrPostResponse",title:"Interface: usePostOrPostResponse",sidebar_label:"@headstartwp/core.react.usePostOrPostResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.useMenuResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"},next:{title:"@headstartwp/core.react.usePostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"}},p={},l=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isArchive",id:"isarchive",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isSingle",id:"issingle",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-5",level:4}],d={toc:l};function c(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".usePostOrPostResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"usePostOrPostResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"post?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"posts?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]")))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/useFetchPostOrPosts.ts#L15"},"packages/core/src/react/hooks/useFetchPostOrPosts.ts:15")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"isarchive"},"isArchive"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isArchive"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/useFetchPostOrPosts.ts#L17"},"packages/core/src/react/hooks/useFetchPostOrPosts.ts:17")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"issingle"},"isSingle"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isSingle"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/useFetchPostOrPosts.ts#L16"},"packages/core/src/react/hooks/useFetchPostOrPosts.ts:16")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f1627269.7148769a.js b/assets/js/f1627269.d0fe9701.js similarity index 98% rename from assets/js/f1627269.7148769a.js rename to assets/js/f1627269.d0fe9701.js index 0c7d7e702..21cd4675d 100644 --- a/assets/js/f1627269.7148769a.js +++ b/assets/js/f1627269.d0fe9701.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5653],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>f});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},g=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,s=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),d=p(n),g=a,f=d["".concat(s,".").concat(g)]||d[g]||u[g]||o;return n?r.createElement(f,l(l({ref:t},c),{},{components:n})):r.createElement(f,l({ref:t},c))}));function f(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,l=new Array(o);l[0]=g;var i={};for(var s in t)hasOwnProperty.call(t,s)&&(i[s]=t[s]);i.originalType=e,i[d]="string"==typeof e?e:a,l[1]=i;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var r=n(7462),a=(n(7294),n(3905));const o={slug:"/wordpress-integration/polylang"},l="Polylang Integration",i={unversionedId:"WordPress Integration/polylang",id:"WordPress Integration/polylang",title:"Polylang Integration",description:"Polylang Pro is required since only Polylang Pro offers the REST API integration.",source:"@site/documentation/06-WordPress Integration/polylang.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/polylang",permalink:"/docs/learn/wordpress-integration/polylang",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/polylang.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{slug:"/wordpress-integration/polylang"},sidebar:"tutorialSidebar",previous:{title:"Gutenberg",permalink:"/docs/learn/wordpress-integration/gutenberg"},next:{title:"A/B Test SPA vs MPA navigation",permalink:"/docs/learn/Guides/ab-test-link"}},s={},p=[],c={toc:p};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"polylang-integration"},"Polylang Integration"),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"Polylang Pro is required since only Polylang Pro offers the ",(0,a.kt)("a",{parentName:"p",href:"https://polylang.pro/doc/rest-api/"},"REST API integration"),".")),(0,a.kt)("p",null,"It is possible to integrate with Polylang by enabling the integration in ",(0,a.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," and adding the supported locales to ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/advanced-features/i18n-routing"},"Next.js config"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n // other settings\n integrations: {\n yoastSEO: {\n enable: true,\n },\n polylang: {\n enable: true\n },\n },\n};\n")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="next.config.js"',title:'"next.config.js"'},"module.exports = {\n i18n: {\n // These are all the locales you want to support in\n // your application\n locales: ['en', 'fr', 'nl'],\n // This is the default locale you want to be used when visiting\n // a non-locale prefixed path e.g. `/hello`\n defaultLocale: 'en',\n }\n};\n")),(0,a.kt)("admonition",{type:"info"},(0,a.kt)("p",{parentName:"admonition"},"You need to make sure that the locales set in Polylang matches the locales set in Next.js config.")),(0,a.kt)("p",null,"Enabling this integration will automatically add the ",(0,a.kt)("inlineCode",{parentName:"p"},"lang")," attribute to all REST API calls made to WordPres (when using the data-fetching layer provided by the framework). The ",(0,a.kt)("inlineCode",{parentName:"p"},"lang")," attribute will be set based on the current Next.js locale (",(0,a.kt)("inlineCode",{parentName:"p"},"context.locale")," or ",(0,a.kt)("inlineCode",{parentName:"p"},"context.defaultLocale"),")."))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5653],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>f});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},g=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,s=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),d=p(n),g=a,f=d["".concat(s,".").concat(g)]||d[g]||u[g]||o;return n?r.createElement(f,l(l({ref:t},c),{},{components:n})):r.createElement(f,l({ref:t},c))}));function f(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,l=new Array(o);l[0]=g;var i={};for(var s in t)hasOwnProperty.call(t,s)&&(i[s]=t[s]);i.originalType=e,i[d]="string"==typeof e?e:a,l[1]=i;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var r=n(7462),a=(n(7294),n(3905));const o={slug:"/wordpress-integration/polylang"},l="Polylang Integration",i={unversionedId:"WordPress Integration/polylang",id:"WordPress Integration/polylang",title:"Polylang Integration",description:"Polylang Pro is required since only Polylang Pro offers the REST API integration.",source:"@site/documentation/06-WordPress Integration/polylang.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/polylang",permalink:"/docs/learn/wordpress-integration/polylang",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/polylang.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{slug:"/wordpress-integration/polylang"},sidebar:"tutorialSidebar",previous:{title:"Gutenberg",permalink:"/docs/learn/wordpress-integration/gutenberg"},next:{title:"A/B Test SPA vs MPA navigation",permalink:"/docs/learn/Guides/ab-test-link"}},s={},p=[],c={toc:p};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"polylang-integration"},"Polylang Integration"),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"Polylang Pro is required since only Polylang Pro offers the ",(0,a.kt)("a",{parentName:"p",href:"https://polylang.pro/doc/rest-api/"},"REST API integration"),".")),(0,a.kt)("p",null,"It is possible to integrate with Polylang by enabling the integration in ",(0,a.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," and adding the supported locales to ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/advanced-features/i18n-routing"},"Next.js config"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n // other settings\n integrations: {\n yoastSEO: {\n enable: true,\n },\n polylang: {\n enable: true\n },\n },\n};\n")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="next.config.js"',title:'"next.config.js"'},"module.exports = {\n i18n: {\n // These are all the locales you want to support in\n // your application\n locales: ['en', 'fr', 'nl'],\n // This is the default locale you want to be used when visiting\n // a non-locale prefixed path e.g. `/hello`\n defaultLocale: 'en',\n }\n};\n")),(0,a.kt)("admonition",{type:"info"},(0,a.kt)("p",{parentName:"admonition"},"You need to make sure that the locales set in Polylang matches the locales set in Next.js config.")),(0,a.kt)("p",null,"Enabling this integration will automatically add the ",(0,a.kt)("inlineCode",{parentName:"p"},"lang")," attribute to all REST API calls made to WordPres (when using the data-fetching layer provided by the framework). The ",(0,a.kt)("inlineCode",{parentName:"p"},"lang")," attribute will be set based on the current Next.js locale (",(0,a.kt)("inlineCode",{parentName:"p"},"context.locale")," or ",(0,a.kt)("inlineCode",{parentName:"p"},"context.defaultLocale"),")."))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f2d13ce1.088b6a2f.js b/assets/js/f2d13ce1.98103ef4.js similarity index 96% rename from assets/js/f2d13ce1.088b6a2f.js rename to assets/js/f2d13ce1.98103ef4.js index 9ece43cc5..bbde73ae1 100644 --- a/assets/js/f2d13ce1.088b6a2f.js +++ b/assets/js/f2d13ce1.98103ef4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5355],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),d=c(r),m=n,h=d["".concat(p,".").concat(m)]||d[m]||k[m]||i;return r?a.createElement(h,l(l({ref:t},s),{},{components:r})):a.createElement(h,l({ref:t},s))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[d]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.ColumnsBlockProps",title:"Interface: ColumnsBlockProps",sidebar_label:"@headstartwp/core.react.ColumnsBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ColumnsBlockProps",id:"interfaces/headstartwp_core.react.ColumnsBlockProps",title:"Interface: ColumnsBlockProps",description:"@headstartwp/core.react.ColumnsBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ColumnsBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ColumnsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ColumnsBlockProps",title:"Interface: ColumnsBlockProps",sidebar_label:"@headstartwp/core.react.ColumnsBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ColumnBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},next:{title:"@headstartwp/core.react.CoverBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ColumnsBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ColumnsBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5355],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),d=c(r),m=n,h=d["".concat(p,".").concat(m)]||d[m]||k[m]||i;return r?a.createElement(h,l(l({ref:t},s),{},{components:r})):a.createElement(h,l({ref:t},s))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[d]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.ColumnsBlockProps",title:"Interface: ColumnsBlockProps",sidebar_label:"@headstartwp/core.react.ColumnsBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ColumnsBlockProps",id:"interfaces/headstartwp_core.react.ColumnsBlockProps",title:"Interface: ColumnsBlockProps",description:"@headstartwp/core.react.ColumnsBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ColumnsBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ColumnsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ColumnsBlockProps",title:"Interface: ColumnsBlockProps",sidebar_label:"@headstartwp/core.react.ColumnsBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ColumnBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},next:{title:"@headstartwp/core.react.CoverBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ColumnsBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ColumnsBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f3283cd4.44c665de.js b/assets/js/f3283cd4.8148c2ea.js similarity index 99% rename from assets/js/f3283cd4.44c665de.js rename to assets/js/f3283cd4.8148c2ea.js index c2a6f07b1..b9df1ff60 100644 --- a/assets/js/f3283cd4.44c665de.js +++ b/assets/js/f3283cd4.8148c2ea.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8604],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>h});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),l=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},d=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},g=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),c=l(n),g=r,h=c["".concat(p,".").concat(g)]||c[g]||u[g]||o;return n?a.createElement(h,s(s({ref:t},d),{},{components:n})):a.createElement(h,s({ref:t},d))}));function h(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,s=new Array(o);s[0]=g;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[c]="string"==typeof e?e:r,s[1]=i;for(var l=2;l{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>c,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var a=n(7462),r=(n(7294),n(3905));const o={slug:"/getting-started/setting-up-manually",sidebar_position:1},s="Setting up the framework from scratch",i={unversionedId:"Getting Started/setting-up-manually",id:"Getting Started/setting-up-manually",title:"Setting up the framework from scratch",description:"The recommended way to get started with the framework is by installing the official starter project. See Quick Setup for more information.",source:"@site/documentation/01-Getting Started/setting-up-manually.md",sourceDirName:"01-Getting Started",slug:"/getting-started/setting-up-manually",permalink:"/docs/learn/getting-started/setting-up-manually",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/01-Getting Started/setting-up-manually.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:1,frontMatter:{slug:"/getting-started/setting-up-manually",sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Quick Setup",permalink:"/docs/learn/getting-started/quick-setup"},next:{title:"Configuring the Framework",permalink:"/docs/learn/getting-started/headless-config"}},p={},l=[{value:"Bootstrap the Next.js project",id:"bootstrap-the-nextjs-project",level:2},{value:"headstartwp.config.js",id:"headstartwpconfigjs",level:3},{value:"Env variables",id:"env-variables",level:3},{value:"next.config.js",id:"nextconfigjs",level:3},{value:"pages/_app.js",id:"pages_appjs",level:3},{value:"Setting up the preview endpoint",id:"setting-up-the-preview-endpoint",level:3},{value:"Setting up the revalidate endpoint",id:"setting-up-the-revalidate-endpoint",level:3},{value:"Creating your first route",id:"creating-your-first-route",level:3},{value:"Add SSR/SSG",id:"add-ssrssg",level:3}],d={toc:l};function c(e){let{components:t,...o}=e;return(0,r.kt)("wrapper",(0,a.Z)({},d,o,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"setting-up-the-framework-from-scratch"},"Setting up the framework from scratch"),(0,r.kt)("p",null,"The recommended way to get started with the framework is by installing the official starter project. See ",(0,r.kt)("a",{parentName:"p",href:"/learn/getting-started/quick-setup/"},"Quick Setup")," for more information."),(0,r.kt)("p",null,"This guide will help you set up the framework in a clean Next.js project."),(0,r.kt)("h2",{id:"bootstrap-the-nextjs-project"},"Bootstrap the Next.js project"),(0,r.kt)("p",null,"Start by bootstrapping your next.js project."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},"npx create-next-app@latest --use-npm\n")),(0,r.kt)("p",null,"and install the following packages"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"npm install --save @headstartwp/core @headstartwp/next\n")),(0,r.kt)("h3",{id:"headstartwpconfigjs"},"headstartwp.config.js"),(0,r.kt)("p",null,"Create a ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," file at the root of your Next.js project."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"/**\n * Headless Config\n *\n * @type {import('@headstartwp/core').HeadlessConfig}\n */\nmodule.exports = {\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n\n useWordPressPlugin: true,\n};\n")),(0,r.kt)("h3",{id:"env-variables"},"Env variables"),(0,r.kt)("p",null,"Then create a ",(0,r.kt)("inlineCode",{parentName:"p"},".env")," (or ",(0,r.kt)("inlineCode",{parentName:"p"},".env.local"),") with the following contents:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"NEXT_PUBLIC_HEADLESS_WP_URL=https://my-wordpress.test\n")),(0,r.kt)("p",null,"You can call the env variable anything you want, just make sure to update ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," accordingly."),(0,r.kt)("p",null,"If you're developing locally and your WordPress instance uses https but does not have a valid cert, add ",(0,r.kt)("inlineCode",{parentName:"p"},"NODE_TLS_REJECT_UNAUTHORIZED=0")," to your env variables."),(0,r.kt)("h3",{id:"nextconfigjs"},"next.config.js"),(0,r.kt)("p",null,"Create a ",(0,r.kt)("inlineCode",{parentName:"p"},"next.config.js")," file with the following contents:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=next.config.js",title:"next.config.js"},"const { withHeadstartWPConfig } = require('@headstartwp/next/config');\n\n/**\n * Update whatever you need within the nextConfig object.\n *\n * @type {import('next').NextConfig}\n */\nconst nextConfig = {};\n\nmodule.exports = withHeadstartWPConfig(nextConfig);\n")),(0,r.kt)("h3",{id:"pages_appjs"},"pages/_app.js"),(0,r.kt)("p",null,"Create a custom ",(0,r.kt)("inlineCode",{parentName:"p"},"_app.js")," to wrap the application with ",(0,r.kt)("inlineCode",{parentName:"p"},"HeadlessApp")," component."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/_app.js",title:"src/pages/_app.js"},"import { HeadlessApp } from '@headstartwp/next';\nimport Link from 'next/link';\nimport Router from 'next/router';\n\nimport '../styles.css';\n\nconst MyApp = ({ Component, pageProps }) => {\n // only HeadlessApp needs fallback and themeJson, so we remove them from the props we pass down to the pages\n\n // eslint-disable-next-line react/prop-types, no-unused-vars\n const { fallback = {}, themeJson = {}, ...props } = pageProps;\n\n return (\n \n \n \n );\n};\n\nexport default MyApp;\n")),(0,r.kt)("h3",{id:"setting-up-the-preview-endpoint"},"Setting up the preview endpoint"),(0,r.kt)("p",null,"The WordPress plugin expects the preview endpoint to be located at ",(0,r.kt)("inlineCode",{parentName:"p"},"/api/preview"),"."),(0,r.kt)("p",null,"To enable support for previews, create a ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/api/preview.js")," with the following contents:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/api/preview.js",title:"src/pages/api/preview.js"},"import { previewHandler } from '@headstartwp/next';\n\n/**\n * The Preview endpoint just needs to proxy the default preview handler\n *\n * @param {*} req Next.js request object\n * @param {*} res Next.js response object\n *\n * @returns\n */\nexport default async function handler(req, res) {\n return previewHandler(req, res);\n}\n")),(0,r.kt)("h3",{id:"setting-up-the-revalidate-endpoint"},"Setting up the revalidate endpoint"),(0,r.kt)("p",null,"The framework supports ISR revalidation triggered by WordPress. To enable ISR revalidate, make sure you have the WordPress plugin enabled and activate the option in WordPress settings."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"ISR Option",src:n(2652).Z,width:"1830",height:"342"})),(0,r.kt)("p",null,"Then add the ",(0,r.kt)("inlineCode",{parentName:"p"},"revalidateHandler")," to ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/api/revalidate.js")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/api/revalidate.js",title:"src/pages/api/revalidate.js"},"import { revalidateHandler } from '@headstartwp/next';\n\n/**\n * The revalidate endpoint just needs to proxy the default revalidate handler\n *\n * @param {*} req Next.js request object\n * @param {*} res Next.js response object\n *\n * @returns\n */\nexport default async function handler(req, res) {\n return revalidateHandler(req, res);\n}\n")),(0,r.kt)("h3",{id:"creating-your-first-route"},"Creating your first route"),(0,r.kt)("p",null,"To make sure everything is working as expected create a catch-all route called ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/[...path].js"),". This route will be responsible for rendering single post and pages."),(0,r.kt)("p",null,"By creating a ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," route, the framework will automatically detect and extract URL parameters from the ",(0,r.kt)("inlineCode",{parentName:"p"},"path")," argument."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/[...path].js",title:"src/pages/[...path].js"},"import {\n usePost,\n fetchHookData,\n addHookData,\n handleError,\n usePosts\n} from '@headstartwp/next';\nimport { BlocksRenderer } from '@headstartwp/core/react';\n\nconst params = { postType: ['post', 'page' ] };\n\nconst SinglePostsPage = () => {\n const { loading, error, data } = usePost(params);\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n

{data.post.title.rendered}

\n \n
\n );\n};\n\nexport default SinglePostsPage;\n")),(0,r.kt)("p",null,"Then, visit any single post or page, e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"http://localhost:3000/hello-world")," and you should see both the title and the content of that post/page."),(0,r.kt)("p",null,"Date URLs will also work: e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"http://localhost:3000/2022/10/2/hello-world")),(0,r.kt)("h3",{id:"add-ssrssg"},"Add SSR/SSG"),(0,r.kt)("p",null,"With the example above, you might have noticed that the data is only being fetched on the client. You must use one of the Next.js data fetching methods to enable SSR/SSG."),(0,r.kt)("p",null,"Add this to the ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/[...path].js")," file"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"// or export async function getServerSideProps(context)\nexport async function getStaticProps(context) {\n try {\n // make sure to pass the same params to fetchHookData and usePost\n const usePostData = await fetchHookData(usePost.fetcher(), context, { params });\n\n return addHookData([usePostData], {});\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("p",null,"Then refresh the page and voil\xe1! Data is now being fetched on the server."))}c.isMDXComponent=!0},2652:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/revalidate-option-2ea5f7ed5040a6a9df3edd4ef64315e2.png"}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8604],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>h});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),l=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},d=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},g=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),c=l(n),g=r,h=c["".concat(p,".").concat(g)]||c[g]||u[g]||o;return n?a.createElement(h,s(s({ref:t},d),{},{components:n})):a.createElement(h,s({ref:t},d))}));function h(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,s=new Array(o);s[0]=g;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[c]="string"==typeof e?e:r,s[1]=i;for(var l=2;l{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>c,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var a=n(7462),r=(n(7294),n(3905));const o={slug:"/getting-started/setting-up-manually",sidebar_position:1},s="Setting up the framework from scratch",i={unversionedId:"Getting Started/setting-up-manually",id:"Getting Started/setting-up-manually",title:"Setting up the framework from scratch",description:"The recommended way to get started with the framework is by installing the official starter project. See Quick Setup for more information.",source:"@site/documentation/01-Getting Started/setting-up-manually.md",sourceDirName:"01-Getting Started",slug:"/getting-started/setting-up-manually",permalink:"/docs/learn/getting-started/setting-up-manually",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/01-Getting Started/setting-up-manually.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:1,frontMatter:{slug:"/getting-started/setting-up-manually",sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Quick Setup",permalink:"/docs/learn/getting-started/quick-setup"},next:{title:"Configuring the Framework",permalink:"/docs/learn/getting-started/headless-config"}},p={},l=[{value:"Bootstrap the Next.js project",id:"bootstrap-the-nextjs-project",level:2},{value:"headstartwp.config.js",id:"headstartwpconfigjs",level:3},{value:"Env variables",id:"env-variables",level:3},{value:"next.config.js",id:"nextconfigjs",level:3},{value:"pages/_app.js",id:"pages_appjs",level:3},{value:"Setting up the preview endpoint",id:"setting-up-the-preview-endpoint",level:3},{value:"Setting up the revalidate endpoint",id:"setting-up-the-revalidate-endpoint",level:3},{value:"Creating your first route",id:"creating-your-first-route",level:3},{value:"Add SSR/SSG",id:"add-ssrssg",level:3}],d={toc:l};function c(e){let{components:t,...o}=e;return(0,r.kt)("wrapper",(0,a.Z)({},d,o,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"setting-up-the-framework-from-scratch"},"Setting up the framework from scratch"),(0,r.kt)("p",null,"The recommended way to get started with the framework is by installing the official starter project. See ",(0,r.kt)("a",{parentName:"p",href:"/learn/getting-started/quick-setup/"},"Quick Setup")," for more information."),(0,r.kt)("p",null,"This guide will help you set up the framework in a clean Next.js project."),(0,r.kt)("h2",{id:"bootstrap-the-nextjs-project"},"Bootstrap the Next.js project"),(0,r.kt)("p",null,"Start by bootstrapping your next.js project."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},"npx create-next-app@latest --use-npm\n")),(0,r.kt)("p",null,"and install the following packages"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"npm install --save @headstartwp/core @headstartwp/next\n")),(0,r.kt)("h3",{id:"headstartwpconfigjs"},"headstartwp.config.js"),(0,r.kt)("p",null,"Create a ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," file at the root of your Next.js project."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"/**\n * Headless Config\n *\n * @type {import('@headstartwp/core').HeadlessConfig}\n */\nmodule.exports = {\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n\n useWordPressPlugin: true,\n};\n")),(0,r.kt)("h3",{id:"env-variables"},"Env variables"),(0,r.kt)("p",null,"Then create a ",(0,r.kt)("inlineCode",{parentName:"p"},".env")," (or ",(0,r.kt)("inlineCode",{parentName:"p"},".env.local"),") with the following contents:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"NEXT_PUBLIC_HEADLESS_WP_URL=https://my-wordpress.test\n")),(0,r.kt)("p",null,"You can call the env variable anything you want, just make sure to update ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," accordingly."),(0,r.kt)("p",null,"If you're developing locally and your WordPress instance uses https but does not have a valid cert, add ",(0,r.kt)("inlineCode",{parentName:"p"},"NODE_TLS_REJECT_UNAUTHORIZED=0")," to your env variables."),(0,r.kt)("h3",{id:"nextconfigjs"},"next.config.js"),(0,r.kt)("p",null,"Create a ",(0,r.kt)("inlineCode",{parentName:"p"},"next.config.js")," file with the following contents:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=next.config.js",title:"next.config.js"},"const { withHeadstartWPConfig } = require('@headstartwp/next/config');\n\n/**\n * Update whatever you need within the nextConfig object.\n *\n * @type {import('next').NextConfig}\n */\nconst nextConfig = {};\n\nmodule.exports = withHeadstartWPConfig(nextConfig);\n")),(0,r.kt)("h3",{id:"pages_appjs"},"pages/_app.js"),(0,r.kt)("p",null,"Create a custom ",(0,r.kt)("inlineCode",{parentName:"p"},"_app.js")," to wrap the application with ",(0,r.kt)("inlineCode",{parentName:"p"},"HeadlessApp")," component."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/_app.js",title:"src/pages/_app.js"},"import { HeadlessApp } from '@headstartwp/next';\nimport Link from 'next/link';\nimport Router from 'next/router';\n\nimport '../styles.css';\n\nconst MyApp = ({ Component, pageProps }) => {\n // only HeadlessApp needs fallback and themeJson, so we remove them from the props we pass down to the pages\n\n // eslint-disable-next-line react/prop-types, no-unused-vars\n const { fallback = {}, themeJson = {}, ...props } = pageProps;\n\n return (\n \n \n
\n );\n};\n\nexport default MyApp;\n")),(0,r.kt)("h3",{id:"setting-up-the-preview-endpoint"},"Setting up the preview endpoint"),(0,r.kt)("p",null,"The WordPress plugin expects the preview endpoint to be located at ",(0,r.kt)("inlineCode",{parentName:"p"},"/api/preview"),"."),(0,r.kt)("p",null,"To enable support for previews, create a ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/api/preview.js")," with the following contents:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/api/preview.js",title:"src/pages/api/preview.js"},"import { previewHandler } from '@headstartwp/next';\n\n/**\n * The Preview endpoint just needs to proxy the default preview handler\n *\n * @param {*} req Next.js request object\n * @param {*} res Next.js response object\n *\n * @returns\n */\nexport default async function handler(req, res) {\n return previewHandler(req, res);\n}\n")),(0,r.kt)("h3",{id:"setting-up-the-revalidate-endpoint"},"Setting up the revalidate endpoint"),(0,r.kt)("p",null,"The framework supports ISR revalidation triggered by WordPress. To enable ISR revalidate, make sure you have the WordPress plugin enabled and activate the option in WordPress settings."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"ISR Option",src:n(2652).Z,width:"1830",height:"342"})),(0,r.kt)("p",null,"Then add the ",(0,r.kt)("inlineCode",{parentName:"p"},"revalidateHandler")," to ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/api/revalidate.js")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/api/revalidate.js",title:"src/pages/api/revalidate.js"},"import { revalidateHandler } from '@headstartwp/next';\n\n/**\n * The revalidate endpoint just needs to proxy the default revalidate handler\n *\n * @param {*} req Next.js request object\n * @param {*} res Next.js response object\n *\n * @returns\n */\nexport default async function handler(req, res) {\n return revalidateHandler(req, res);\n}\n")),(0,r.kt)("h3",{id:"creating-your-first-route"},"Creating your first route"),(0,r.kt)("p",null,"To make sure everything is working as expected create a catch-all route called ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/[...path].js"),". This route will be responsible for rendering single post and pages."),(0,r.kt)("p",null,"By creating a ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," route, the framework will automatically detect and extract URL parameters from the ",(0,r.kt)("inlineCode",{parentName:"p"},"path")," argument."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/[...path].js",title:"src/pages/[...path].js"},"import {\n usePost,\n fetchHookData,\n addHookData,\n handleError,\n usePosts\n} from '@headstartwp/next';\nimport { BlocksRenderer } from '@headstartwp/core/react';\n\nconst params = { postType: ['post', 'page' ] };\n\nconst SinglePostsPage = () => {\n const { loading, error, data } = usePost(params);\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n

{data.post.title.rendered}

\n \n
\n );\n};\n\nexport default SinglePostsPage;\n")),(0,r.kt)("p",null,"Then, visit any single post or page, e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"http://localhost:3000/hello-world")," and you should see both the title and the content of that post/page."),(0,r.kt)("p",null,"Date URLs will also work: e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"http://localhost:3000/2022/10/2/hello-world")),(0,r.kt)("h3",{id:"add-ssrssg"},"Add SSR/SSG"),(0,r.kt)("p",null,"With the example above, you might have noticed that the data is only being fetched on the client. You must use one of the Next.js data fetching methods to enable SSR/SSG."),(0,r.kt)("p",null,"Add this to the ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/[...path].js")," file"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"// or export async function getServerSideProps(context)\nexport async function getStaticProps(context) {\n try {\n // make sure to pass the same params to fetchHookData and usePost\n const usePostData = await fetchHookData(usePost.fetcher(), context, { params });\n\n return addHookData([usePostData], {});\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("p",null,"Then refresh the page and voil\xe1! Data is now being fetched on the server."))}c.isMDXComponent=!0},2652:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/revalidate-option-2ea5f7ed5040a6a9df3edd4ef64315e2.png"}}]); \ No newline at end of file diff --git a/assets/js/f3d95041.7d8b3329.js b/assets/js/f3d95041.5de1a48c.js similarity index 99% rename from assets/js/f3d95041.7d8b3329.js rename to assets/js/f3d95041.5de1a48c.js index 76b8f6b39..bc72f2f60 100644 --- a/assets/js/f3d95041.7d8b3329.js +++ b/assets/js/f3d95041.5de1a48c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5405],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>h});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var i=n.createContext({}),c=function(e){var t=n.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},p=function(e){var t=c(e.components);return n.createElement(i.Provider,{value:t},e.children)},d="mdxType",_={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,i=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),d=c(r),u=a,h=d["".concat(i,".").concat(u)]||d[u]||_[u]||o;return r?n.createElement(h,l(l({ref:t},p),{},{components:r})):n.createElement(h,l({ref:t},p))}));function h(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,l=new Array(o);l[0]=u;var s={};for(var i in t)hasOwnProperty.call(t,i)&&(s[i]=t[i]);s.originalType=e,s[d]="string"==typeof e?e:a,l[1]=s;for(var c=2;c{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>l,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>c});var n=r(7462),a=(r(7294),r(3905));const o={slug:"/wordpress-integration/gutenberg"},l="Gutenberg",s={unversionedId:"WordPress Integration/gutenberg",id:"WordPress Integration/gutenberg",title:"Gutenberg",description:"The HeadstartWP Plugin enhances every block with two special attributes directly in the markup: data-wp-block-name and data-wp-block. The first holds the name of the block and the second holds all of the block attributes.",source:"@site/documentation/06-WordPress Integration/gutenberg.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/gutenberg",permalink:"/docs/learn/wordpress-integration/gutenberg",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/gutenberg.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{slug:"/wordpress-integration/gutenberg"},sidebar:"tutorialSidebar",previous:{title:"Feeds",permalink:"/docs/learn/wordpress-integration/feeds"},next:{title:"Polylang Integration",permalink:"/docs/learn/wordpress-integration/polylang"}},i={},c=[{value:"Available Filters",id:"available-filters",level:2},{value:"tenup_headless_wp_render_block_attrs",id:"tenup_headless_wp_render_block_attrs",level:3},{value:"tenup_headless_wp_render_blocks_attrs_serialized",id:"tenup_headless_wp_render_blocks_attrs_serialized",level:3},{value:"tenup_headless_wp_render_block_use_tag_processor",id:"tenup_headless_wp_render_block_use_tag_processor",level:3},{value:"tenup_headless_wp_render_block_markup",id:"tenup_headless_wp_render_block_markup",level:3},{value:"tenup_headless_wp_render_html_tag_processor_block_markup",id:"tenup_headless_wp_render_html_tag_processor_block_markup",level:3}],p={toc:c};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"gutenberg"},"Gutenberg"),(0,a.kt)("p",null,"The HeadstartWP Plugin enhances every block with two special attributes directly in the markup: ",(0,a.kt)("inlineCode",{parentName:"p"},"data-wp-block-name")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"data-wp-block"),". The first holds the name of the block and the second holds all of the block attributes."),(0,a.kt)("p",null,"These data attributes can be used for matching blocks in ",(0,a.kt)("inlineCode",{parentName:"p"},"BlocksRenderer")," and for accessing block's attributes directly in your React component."),(0,a.kt)("h2",{id:"available-filters"},"Available Filters"),(0,a.kt)("p",null,"There are a few filters available that you can hook into."),(0,a.kt)("h3",{id:"tenup_headless_wp_render_block_attrs"},"tenup_headless_wp_render_block_attrs"),(0,a.kt)("p",null,"This filter allows you to filter the block attributes before serializing them into the markup. You can use this to include additional attributes that you might need on the front-end. For instance, you can add information for a post instead of just a post id to prevent making an extra HTTP request to get the data for a post."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filter's out the block's attributes before serializing in the block markup.\n *\n * @param array $attrs The Block's Attributes\n * @param array $block The Block's schema\n * @param \\WP_Block $block_instance The block's instance\n */\n$block_attrs = apply_filters( \n 'tenup_headless_wp_render_block_attrs', \n $block_attrs, \n $block, \n $block_instance \n);\n")),(0,a.kt)("h3",{id:"tenup_headless_wp_render_blocks_attrs_serialized"},"tenup_headless_wp_render_blocks_attrs_serialized"),(0,a.kt)("p",null,"This filter is not as useful as the previous one but it allows you to filter the serialized attributes."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filter's out the block's attributes after serialization\n *\n * @param string $encoded_attrs The serialized block's Attributes\n * @param array $attrs The Block's Attributes\n * @param array $block The Block's schema\n * @param \\WP_Block $block_instance The block's instance\n */\n$block_attrs_serialized = apply_filters(\n 'tenup_headless_wp_render_blocks_attrs_serialized',\n esc_attr( wp_json_encode( $block_attrs ) ),\n $block_attrs,\n $block,\n $block_instance\n);\n")),(0,a.kt)("h3",{id:"tenup_headless_wp_render_block_use_tag_processor"},"tenup_headless_wp_render_block_use_tag_processor"),(0,a.kt)("p",null,"HeadstartWP will use the DomDocument API for parsing and enhancing the block markup by default. Since 1.0.7, it is possible to opt into the new ",(0,a.kt)("inlineCode",{parentName:"p"},"WP_Html_Tag_Processor")," API via the ",(0,a.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_render_block_use_tag_processor"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"add_filter( 'tenup_headless_wp_render_block_use_tag_processor', '__return_true' );\n")),(0,a.kt)("p",null,"In the next major release, usage of the DomDocument API will be removed in favor of ",(0,a.kt)("inlineCode",{parentName:"p"},"WP_Html_Tag_Processor")," since it's easier to use and a core API. For most users this should not change anything, both APIs should yield the same result and the deprecation of the DomDocument API is merely for simplicity."),(0,a.kt)("h3",{id:"tenup_headless_wp_render_block_markup"},"tenup_headless_wp_render_block_markup"),(0,a.kt)("p",null,"This filter is called after adding the data attributes but before returning the block's final markup. You can use this filter to perform any additional modifications to the block markup."),(0,a.kt)("p",null,"This filter is only called when using the DomDocument API (i.e - the filter ",(0,a.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_render_block_use_tag_processor")," returns false)."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filter the block's DOMElement before rendering\n *\n * @param \\DOMElement $root_node\n * @param string $html The original block markup\n * @param array $block The Block's schema\n * @param \\WP_Block $block_instance The block's instance\n */\n$root_node = apply_filters( \n 'tenup_headless_wp_render_block_markup', \n $root_node, \n $html, \n $block, \n $block_instance\n);\n")),(0,a.kt)("h3",{id:"tenup_headless_wp_render_html_tag_processor_block_markup"},"tenup_headless_wp_render_html_tag_processor_block_markup"),(0,a.kt)("p",null,"This filter is called after adding the data attributes but before returning the block's final markup when the ",(0,a.kt)("inlineCode",{parentName:"p"},"WP_HTML_Tag_Processor")," API is being used. You can use this filter to perform any additional modifications to the block markup."),(0,a.kt)("p",null,"This filter is only called when using the WP_HTML_Tag_Processor API (i.e - the filter ",(0,a.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_render_block_use_tag_processor")," returns true)."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filter the block's before rendering\n *\n * @param \\WP_HTML_Tag_Processor $doc\n * @param string $html The original block markup\n * @param array $block The Block's schema\n * @param \\WP_Block $block_instance The block's instance\n */\n$doc = apply_filters( \n 'tenup_headless_wp_render_html_tag_processor_block_markup', \n $doc, \n $html, \n $block, \n $block_instance\n);\n")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5405],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>h});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var i=n.createContext({}),c=function(e){var t=n.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},p=function(e){var t=c(e.components);return n.createElement(i.Provider,{value:t},e.children)},d="mdxType",_={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,i=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),d=c(r),u=a,h=d["".concat(i,".").concat(u)]||d[u]||_[u]||o;return r?n.createElement(h,l(l({ref:t},p),{},{components:r})):n.createElement(h,l({ref:t},p))}));function h(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,l=new Array(o);l[0]=u;var s={};for(var i in t)hasOwnProperty.call(t,i)&&(s[i]=t[i]);s.originalType=e,s[d]="string"==typeof e?e:a,l[1]=s;for(var c=2;c{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>l,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>c});var n=r(7462),a=(r(7294),r(3905));const o={slug:"/wordpress-integration/gutenberg"},l="Gutenberg",s={unversionedId:"WordPress Integration/gutenberg",id:"WordPress Integration/gutenberg",title:"Gutenberg",description:"The HeadstartWP Plugin enhances every block with two special attributes directly in the markup: data-wp-block-name and data-wp-block. The first holds the name of the block and the second holds all of the block attributes.",source:"@site/documentation/06-WordPress Integration/gutenberg.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/gutenberg",permalink:"/docs/learn/wordpress-integration/gutenberg",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/gutenberg.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{slug:"/wordpress-integration/gutenberg"},sidebar:"tutorialSidebar",previous:{title:"Feeds",permalink:"/docs/learn/wordpress-integration/feeds"},next:{title:"Polylang Integration",permalink:"/docs/learn/wordpress-integration/polylang"}},i={},c=[{value:"Available Filters",id:"available-filters",level:2},{value:"tenup_headless_wp_render_block_attrs",id:"tenup_headless_wp_render_block_attrs",level:3},{value:"tenup_headless_wp_render_blocks_attrs_serialized",id:"tenup_headless_wp_render_blocks_attrs_serialized",level:3},{value:"tenup_headless_wp_render_block_use_tag_processor",id:"tenup_headless_wp_render_block_use_tag_processor",level:3},{value:"tenup_headless_wp_render_block_markup",id:"tenup_headless_wp_render_block_markup",level:3},{value:"tenup_headless_wp_render_html_tag_processor_block_markup",id:"tenup_headless_wp_render_html_tag_processor_block_markup",level:3}],p={toc:c};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"gutenberg"},"Gutenberg"),(0,a.kt)("p",null,"The HeadstartWP Plugin enhances every block with two special attributes directly in the markup: ",(0,a.kt)("inlineCode",{parentName:"p"},"data-wp-block-name")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"data-wp-block"),". The first holds the name of the block and the second holds all of the block attributes."),(0,a.kt)("p",null,"These data attributes can be used for matching blocks in ",(0,a.kt)("inlineCode",{parentName:"p"},"BlocksRenderer")," and for accessing block's attributes directly in your React component."),(0,a.kt)("h2",{id:"available-filters"},"Available Filters"),(0,a.kt)("p",null,"There are a few filters available that you can hook into."),(0,a.kt)("h3",{id:"tenup_headless_wp_render_block_attrs"},"tenup_headless_wp_render_block_attrs"),(0,a.kt)("p",null,"This filter allows you to filter the block attributes before serializing them into the markup. You can use this to include additional attributes that you might need on the front-end. For instance, you can add information for a post instead of just a post id to prevent making an extra HTTP request to get the data for a post."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filter's out the block's attributes before serializing in the block markup.\n *\n * @param array $attrs The Block's Attributes\n * @param array $block The Block's schema\n * @param \\WP_Block $block_instance The block's instance\n */\n$block_attrs = apply_filters( \n 'tenup_headless_wp_render_block_attrs', \n $block_attrs, \n $block, \n $block_instance \n);\n")),(0,a.kt)("h3",{id:"tenup_headless_wp_render_blocks_attrs_serialized"},"tenup_headless_wp_render_blocks_attrs_serialized"),(0,a.kt)("p",null,"This filter is not as useful as the previous one but it allows you to filter the serialized attributes."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filter's out the block's attributes after serialization\n *\n * @param string $encoded_attrs The serialized block's Attributes\n * @param array $attrs The Block's Attributes\n * @param array $block The Block's schema\n * @param \\WP_Block $block_instance The block's instance\n */\n$block_attrs_serialized = apply_filters(\n 'tenup_headless_wp_render_blocks_attrs_serialized',\n esc_attr( wp_json_encode( $block_attrs ) ),\n $block_attrs,\n $block,\n $block_instance\n);\n")),(0,a.kt)("h3",{id:"tenup_headless_wp_render_block_use_tag_processor"},"tenup_headless_wp_render_block_use_tag_processor"),(0,a.kt)("p",null,"HeadstartWP will use the DomDocument API for parsing and enhancing the block markup by default. Since 1.0.7, it is possible to opt into the new ",(0,a.kt)("inlineCode",{parentName:"p"},"WP_Html_Tag_Processor")," API via the ",(0,a.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_render_block_use_tag_processor"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"add_filter( 'tenup_headless_wp_render_block_use_tag_processor', '__return_true' );\n")),(0,a.kt)("p",null,"In the next major release, usage of the DomDocument API will be removed in favor of ",(0,a.kt)("inlineCode",{parentName:"p"},"WP_Html_Tag_Processor")," since it's easier to use and a core API. For most users this should not change anything, both APIs should yield the same result and the deprecation of the DomDocument API is merely for simplicity."),(0,a.kt)("h3",{id:"tenup_headless_wp_render_block_markup"},"tenup_headless_wp_render_block_markup"),(0,a.kt)("p",null,"This filter is called after adding the data attributes but before returning the block's final markup. You can use this filter to perform any additional modifications to the block markup."),(0,a.kt)("p",null,"This filter is only called when using the DomDocument API (i.e - the filter ",(0,a.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_render_block_use_tag_processor")," returns false)."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filter the block's DOMElement before rendering\n *\n * @param \\DOMElement $root_node\n * @param string $html The original block markup\n * @param array $block The Block's schema\n * @param \\WP_Block $block_instance The block's instance\n */\n$root_node = apply_filters( \n 'tenup_headless_wp_render_block_markup', \n $root_node, \n $html, \n $block, \n $block_instance\n);\n")),(0,a.kt)("h3",{id:"tenup_headless_wp_render_html_tag_processor_block_markup"},"tenup_headless_wp_render_html_tag_processor_block_markup"),(0,a.kt)("p",null,"This filter is called after adding the data attributes but before returning the block's final markup when the ",(0,a.kt)("inlineCode",{parentName:"p"},"WP_HTML_Tag_Processor")," API is being used. You can use this filter to perform any additional modifications to the block markup."),(0,a.kt)("p",null,"This filter is only called when using the WP_HTML_Tag_Processor API (i.e - the filter ",(0,a.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_render_block_use_tag_processor")," returns true)."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filter the block's before rendering\n *\n * @param \\WP_HTML_Tag_Processor $doc\n * @param string $html The original block markup\n * @param array $block The Block's schema\n * @param \\WP_Block $block_instance The block's instance\n */\n$doc = apply_filters( \n 'tenup_headless_wp_render_html_tag_processor_block_markup', \n $doc, \n $html, \n $block, \n $block_instance\n);\n")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f46c6fb7.de3efe0e.js b/assets/js/f46c6fb7.5915df3e.js similarity index 96% rename from assets/js/f46c6fb7.de3efe0e.js rename to assets/js/f46c6fb7.5915df3e.js index 1a84616ab..a8a94bc09 100644 --- a/assets/js/f46c6fb7.de3efe0e.js +++ b/assets/js/f46c6fb7.5915df3e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1656],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),c=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=r,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?n.createElement(h,l(l({ref:t},d),{},{components:a})):n.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:r,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var n=a(7462),r=(a(7294),a(3905));const o={id:"headstartwp_core.react.IButtonsBlock",title:"Interface: IButtonsBlock",sidebar_label:"@headstartwp/core.react.IButtonsBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IButtonsBlock",id:"interfaces/headstartwp_core.react.IButtonsBlock",title:"Interface: IButtonsBlock",description:"@headstartwp/core.react.IButtonsBlock",source:"@site/docs/interfaces/headstartwp_core.react.IButtonsBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IButtonsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IButtonsBlock",title:"Interface: IButtonsBlock",sidebar_label:"@headstartwp/core.react.IButtonsBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IButtonBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock"},next:{title:"@headstartwp/core.react.ICodeBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IButtonsBlock"),(0,r.kt)("p",null,"The interface for the ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#buttonsblock"},"ButtonsBlock")," component."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonsBlockProps")),">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IButtonsBlock"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classname"},"className"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"component"},"component"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"component"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonsBlockProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonsBlockProps")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1656],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),c=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=r,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?n.createElement(h,l(l({ref:t},d),{},{components:a})):n.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:r,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var n=a(7462),r=(a(7294),a(3905));const o={id:"headstartwp_core.react.IButtonsBlock",title:"Interface: IButtonsBlock",sidebar_label:"@headstartwp/core.react.IButtonsBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IButtonsBlock",id:"interfaces/headstartwp_core.react.IButtonsBlock",title:"Interface: IButtonsBlock",description:"@headstartwp/core.react.IButtonsBlock",source:"@site/docs/interfaces/headstartwp_core.react.IButtonsBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IButtonsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IButtonsBlock",title:"Interface: IButtonsBlock",sidebar_label:"@headstartwp/core.react.IButtonsBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IButtonBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock"},next:{title:"@headstartwp/core.react.ICodeBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IButtonsBlock"),(0,r.kt)("p",null,"The interface for the ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#buttonsblock"},"ButtonsBlock")," component."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonsBlockProps")),">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IButtonsBlock"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classname"},"className"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"component"},"component"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"component"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonsBlockProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonsBlockProps")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f78eec9e.7392531c.js b/assets/js/f78eec9e.d1316f62.js similarity index 91% rename from assets/js/f78eec9e.7392531c.js rename to assets/js/f78eec9e.d1316f62.js index 81bccfd43..512b71172 100644 --- a/assets/js/f78eec9e.7392531c.js +++ b/assets/js/f78eec9e.d1316f62.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8239],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>f});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function p(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var o=a.createContext({}),l=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},d=function(e){var t=l(e.components);return a.createElement(o.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,o=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),c=l(n),u=r,f=c["".concat(o,".").concat(u)]||c[u]||h[u]||i;return n?a.createElement(f,p(p({ref:t},d),{},{components:n})):a.createElement(f,p({ref:t},d))}));function f(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,p=new Array(i);p[0]=u;var s={};for(var o in t)hasOwnProperty.call(t,o)&&(s[o]=t[o]);s.originalType=e,s[c]="string"==typeof e?e:r,p[1]=s;for(var l=2;l{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var a=n(7462),r=(n(7294),n(3905));const i={id:"headstartwp_core.TypeEntity",title:"Interface: TypeEntity",sidebar_label:"@headstartwp/core.TypeEntity",custom_edit_url:null},p=void 0,s={unversionedId:"interfaces/headstartwp_core.TypeEntity",id:"interfaces/headstartwp_core.TypeEntity",title:"Interface: TypeEntity",description:"@headstartwp/core.TypeEntity",source:"@site/docs/interfaces/headstartwp_core.TypeEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.TypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.TypeEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.TypeEntity",title:"Interface: TypeEntity",sidebar_label:"@headstartwp/core.TypeEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.TermEntity",permalink:"/docs/api/interfaces/headstartwp_core.TermEntity"},next:{title:"@headstartwp/core.VerifyTokenParams",permalink:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"}},o={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"hierarchical",id:"hierarchical",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"rest_base",id:"rest_base",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"taxonomies",id:"taxonomies",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:l};function c(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".TypeEntity"),(0,r.kt)("p",null,"Interface for entities from the /wp/v2/types endpoint."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"TypeEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"A human-readable description of the post type."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L362"},"packages/core/src/data/types/entities.ts:362")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hierarchical"},"hierarchical"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"hierarchical"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Whether or not the post type should have children."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L367"},"packages/core/src/data/types/entities.ts:367")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The title for the post type."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L372"},"packages/core/src/data/types/entities.ts:372")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"rest_base"},"rest","_","base"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"rest","_","base"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"REST base route for the post type."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L382"},"packages/core/src/data/types/entities.ts:382")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"An alphanumeric identifier for the post type."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L377"},"packages/core/src/data/types/entities.ts:377")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"taxonomies"},"taxonomies"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"taxonomies"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Taxonomies associated with post type."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L387"},"packages/core/src/data/types/entities.ts:387")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8239],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>k});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function p(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var o=a.createContext({}),l=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},d=function(e){var t=l(e.components);return a.createElement(o.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,o=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),c=l(n),u=r,k=c["".concat(o,".").concat(u)]||c[u]||h[u]||i;return n?a.createElement(k,p(p({ref:t},d),{},{components:n})):a.createElement(k,p({ref:t},d))}));function k(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,p=new Array(i);p[0]=u;var s={};for(var o in t)hasOwnProperty.call(t,o)&&(s[o]=t[o]);s.originalType=e,s[c]="string"==typeof e?e:r,p[1]=s;for(var l=2;l{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var a=n(7462),r=(n(7294),n(3905));const i={id:"headstartwp_core.TypeEntity",title:"Interface: TypeEntity",sidebar_label:"@headstartwp/core.TypeEntity",custom_edit_url:null},p=void 0,s={unversionedId:"interfaces/headstartwp_core.TypeEntity",id:"interfaces/headstartwp_core.TypeEntity",title:"Interface: TypeEntity",description:"@headstartwp/core.TypeEntity",source:"@site/docs/interfaces/headstartwp_core.TypeEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.TypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.TypeEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.TypeEntity",title:"Interface: TypeEntity",sidebar_label:"@headstartwp/core.TypeEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.TermEntity",permalink:"/docs/api/interfaces/headstartwp_core.TermEntity"},next:{title:"@headstartwp/core.VerifyTokenParams",permalink:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"}},o={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"hierarchical",id:"hierarchical",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"rest_base",id:"rest_base",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"taxonomies",id:"taxonomies",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:l};function c(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".TypeEntity"),(0,r.kt)("p",null,"Interface for entities from the /wp/v2/types endpoint."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"TypeEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"A human-readable description of the post type."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L362"},"packages/core/src/data/types/entities.ts:362")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hierarchical"},"hierarchical"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"hierarchical"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Whether or not the post type should have children."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L367"},"packages/core/src/data/types/entities.ts:367")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The title for the post type."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L372"},"packages/core/src/data/types/entities.ts:372")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"rest_base"},"rest","_","base"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"rest","_","base"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"REST base route for the post type."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L382"},"packages/core/src/data/types/entities.ts:382")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"An alphanumeric identifier for the post type."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L377"},"packages/core/src/data/types/entities.ts:377")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"taxonomies"},"taxonomies"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"taxonomies"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Taxonomies associated with post type."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L387"},"packages/core/src/data/types/entities.ts:387")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f9e6d01e.ef97e126.js b/assets/js/f9e6d01e.243e1eca.js similarity index 86% rename from assets/js/f9e6d01e.ef97e126.js rename to assets/js/f9e6d01e.243e1eca.js index 890e1f938..7bfa2446f 100644 --- a/assets/js/f9e6d01e.ef97e126.js +++ b/assets/js/f9e6d01e.243e1eca.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9898],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},l=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,l=i(e,["components","mdxType","originalType","parentName"]),d=c(r),h=n,f=d["".concat(p,".").concat(h)]||d[h]||u[h]||o;return r?a.createElement(f,s(s({ref:t},l),{},{components:r})):a.createElement(f,s({ref:t},l))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=h;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[d]="string"==typeof e?e:n,s[1]=i;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.useMenuResponse",title:"Interface: useMenuResponse",sidebar_label:"@headstartwp/core.react.useMenuResponse",custom_edit_url:null},s=void 0,i={unversionedId:"interfaces/headstartwp_core.react.useMenuResponse",id:"interfaces/headstartwp_core.react.useMenuResponse",title:"Interface: useMenuResponse",description:"@headstartwp/core.react.useMenuResponse",source:"@site/docs/interfaces/headstartwp_core.react.useMenuResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.useMenuResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.useMenuResponse",title:"Interface: useMenuResponse",sidebar_label:"@headstartwp/core.react.useMenuResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.useFetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.useFetchOptions"},next:{title:"@headstartwp/core.react.usePostOrPostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],l={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".useMenuResponse"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"useMenuResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"MenuItemEntity")),"[]"),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/useFetchMenu.ts#L7"},"packages/core/src/react/hooks/useFetchMenu.ts:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9898],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>f});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},l="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),l=c(r),h=n,f=l["".concat(p,".").concat(h)]||l[h]||u[h]||o;return r?a.createElement(f,s(s({ref:t},d),{},{components:r})):a.createElement(f,s({ref:t},d))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=h;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[l]="string"==typeof e?e:n,s[1]=i;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.useMenuResponse",title:"Interface: useMenuResponse",sidebar_label:"@headstartwp/core.react.useMenuResponse",custom_edit_url:null},s=void 0,i={unversionedId:"interfaces/headstartwp_core.react.useMenuResponse",id:"interfaces/headstartwp_core.react.useMenuResponse",title:"Interface: useMenuResponse",description:"@headstartwp/core.react.useMenuResponse",source:"@site/docs/interfaces/headstartwp_core.react.useMenuResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.useMenuResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.useMenuResponse",title:"Interface: useMenuResponse",sidebar_label:"@headstartwp/core.react.useMenuResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.useFetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.useFetchOptions"},next:{title:"@headstartwp/core.react.usePostOrPostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],d={toc:c};function l(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".useMenuResponse"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"useMenuResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"MenuItemEntity")),"[]"),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/useFetchMenu.ts#L7"},"packages/core/src/react/hooks/useFetchMenu.ts:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}l.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/fae21d27.a875b6ae.js b/assets/js/fae21d27.934a1532.js similarity index 98% rename from assets/js/fae21d27.a875b6ae.js rename to assets/js/fae21d27.934a1532.js index d8a6f4d21..e14b98cec 100644 --- a/assets/js/fae21d27.a875b6ae.js +++ b/assets/js/fae21d27.934a1532.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2179],{3905:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>h});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function s(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=n.createContext({}),d=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},u=function(e){var t=d(e.components);return n.createElement(l.Provider,{value:t},e.children)},p="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,u=i(e,["components","mdxType","originalType","parentName"]),p=d(r),f=o,h=p["".concat(l,".").concat(f)]||p[f]||c[f]||a;return r?n.createElement(h,s(s({ref:t},u),{},{components:r})):n.createElement(h,s({ref:t},u))}));function h(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,s=new Array(a);s[0]=f;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[p]="string"==typeof e?e:o,s[1]=i;for(var d=2;d{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>p,frontMatter:()=>a,metadata:()=>i,toc:()=>d});var n=r(7462),o=(r(7294),r(3905));const a={slug:"/wordpress-integration/feeds"},s="Feeds",i={unversionedId:"WordPress Integration/feeds",id:"WordPress Integration/feeds",title:"Feeds",description:"Feeds are proxied via Next.js rewrites by default. meaning that you can directly access the feed via your front-end/Next.js URL.",source:"@site/documentation/06-WordPress Integration/feeds.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/feeds",permalink:"/docs/learn/wordpress-integration/feeds",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/feeds.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{slug:"/wordpress-integration/feeds"},sidebar:"tutorialSidebar",previous:{title:"Basic Auth",permalink:"/docs/learn/wordpress-integration/basic-auth"},next:{title:"Gutenberg",permalink:"/docs/learn/wordpress-integration/gutenberg"}},l={},d=[{value:"Filtering when to rewrite URLs",id:"filtering-when-to-rewrite-urls",level:2}],u={toc:d};function p(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,n.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"feeds"},"Feeds"),(0,o.kt)("p",null,"Feeds are proxied via Next.js rewrites by default. meaning that you can directly access the feed via your front-end/Next.js URL."),(0,o.kt)("p",null,"If you have the plugin enabled, the URLs in the feed will also be rewritten to use front-end URLs. URLs are only rewritten if ",(0,o.kt)("inlineCode",{parentName:"p"},"?rewrite_urls=1")," is passed to a feed URL (which the framework does automatically). The following is the default rewrite rule set by the framework in Next.js:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"{\n source: `${prefix}/feed`,\n destination: `${wpUrl}/feed/?rewrite_urls=1`,\n},\n")),(0,o.kt)("p",null,"Therefore, accessing the feed from your WordPress domain will display the WP URLs unless you pass ",(0,o.kt)("inlineCode",{parentName:"p"},"?rewrite_urls=1"),"."),(0,o.kt)("h2",{id:"filtering-when-to-rewrite-urls"},"Filtering when to rewrite URLs"),(0,o.kt)("p",null,"If you want to better control when feed URLs are rewritten there's a filter called ",(0,o.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_should_rewrite_feed_urls"),"."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filter's out whether feed urls should be rewritten\n *\n * @param boolean $rewrite_urls Whether the current request should rewrite_urls\n */\nreturn apply_filters( 'tenup_headless_wp_should_rewrite_feed_urls', (bool) $rewrite_urls );\n")),(0,o.kt)("p",null,"You could use this to always enable rewriting the feed URLs or to use a different query param to enable URL rewrites in the feed."))}p.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2179],{3905:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>h});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function s(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=n.createContext({}),d=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},u=function(e){var t=d(e.components);return n.createElement(l.Provider,{value:t},e.children)},p="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,u=i(e,["components","mdxType","originalType","parentName"]),p=d(r),f=o,h=p["".concat(l,".").concat(f)]||p[f]||c[f]||a;return r?n.createElement(h,s(s({ref:t},u),{},{components:r})):n.createElement(h,s({ref:t},u))}));function h(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,s=new Array(a);s[0]=f;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[p]="string"==typeof e?e:o,s[1]=i;for(var d=2;d{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>p,frontMatter:()=>a,metadata:()=>i,toc:()=>d});var n=r(7462),o=(r(7294),r(3905));const a={slug:"/wordpress-integration/feeds"},s="Feeds",i={unversionedId:"WordPress Integration/feeds",id:"WordPress Integration/feeds",title:"Feeds",description:"Feeds are proxied via Next.js rewrites by default. meaning that you can directly access the feed via your front-end/Next.js URL.",source:"@site/documentation/06-WordPress Integration/feeds.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/feeds",permalink:"/docs/learn/wordpress-integration/feeds",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/feeds.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",frontMatter:{slug:"/wordpress-integration/feeds"},sidebar:"tutorialSidebar",previous:{title:"Basic Auth",permalink:"/docs/learn/wordpress-integration/basic-auth"},next:{title:"Gutenberg",permalink:"/docs/learn/wordpress-integration/gutenberg"}},l={},d=[{value:"Filtering when to rewrite URLs",id:"filtering-when-to-rewrite-urls",level:2}],u={toc:d};function p(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,n.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"feeds"},"Feeds"),(0,o.kt)("p",null,"Feeds are proxied via Next.js rewrites by default. meaning that you can directly access the feed via your front-end/Next.js URL."),(0,o.kt)("p",null,"If you have the plugin enabled, the URLs in the feed will also be rewritten to use front-end URLs. URLs are only rewritten if ",(0,o.kt)("inlineCode",{parentName:"p"},"?rewrite_urls=1")," is passed to a feed URL (which the framework does automatically). The following is the default rewrite rule set by the framework in Next.js:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"{\n source: `${prefix}/feed`,\n destination: `${wpUrl}/feed/?rewrite_urls=1`,\n},\n")),(0,o.kt)("p",null,"Therefore, accessing the feed from your WordPress domain will display the WP URLs unless you pass ",(0,o.kt)("inlineCode",{parentName:"p"},"?rewrite_urls=1"),"."),(0,o.kt)("h2",{id:"filtering-when-to-rewrite-urls"},"Filtering when to rewrite URLs"),(0,o.kt)("p",null,"If you want to better control when feed URLs are rewritten there's a filter called ",(0,o.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_should_rewrite_feed_urls"),"."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filter's out whether feed urls should be rewritten\n *\n * @param boolean $rewrite_urls Whether the current request should rewrite_urls\n */\nreturn apply_filters( 'tenup_headless_wp_should_rewrite_feed_urls', (bool) $rewrite_urls );\n")),(0,o.kt)("p",null,"You could use this to always enable rewriting the feed URLs or to use a different query param to enable URL rewrites in the feed."))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/fb675763.9334f728.js b/assets/js/fb675763.18b74a00.js similarity index 99% rename from assets/js/fb675763.9334f728.js rename to assets/js/fb675763.18b74a00.js index 456f3d2bd..e98cfad09 100644 --- a/assets/js/fb675763.9334f728.js +++ b/assets/js/fb675763.18b74a00.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7067],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>k});var o=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var c=o.createContext({}),i=function(e){var t=o.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=i(e.components);return o.createElement(c.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},h=o.forwardRef((function(e,t){var n=e.components,r=e.mdxType,a=e.originalType,c=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),d=i(n),h=r,k=d["".concat(c,".").concat(h)]||d[h]||u[h]||a;return n?o.createElement(k,s(s({ref:t},p),{},{components:n})):o.createElement(k,s({ref:t},p))}));function k(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=n.length,s=new Array(a);s[0]=h;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l[d]="string"==typeof e?e:r,s[1]=l;for(var i=2;i{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>d,frontMatter:()=>a,metadata:()=>l,toc:()=>i});var o=n(7462),r=(n(7294),n(3905));const a={sidebar_label:"Rendering Blocks",sidebar_position:0,slug:"/gutenberg/rendering-blocks"},s="Rendering Blocks",l={unversionedId:"Gutenberg/rendering-blocks",id:"Gutenberg/rendering-blocks",title:"Rendering Blocks",description:"Introduction",source:"@site/documentation/05-Gutenberg/rendering-blocks.md",sourceDirName:"05-Gutenberg",slug:"/gutenberg/rendering-blocks",permalink:"/docs/learn/gutenberg/rendering-blocks",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/05-Gutenberg/rendering-blocks.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933652,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:0,frontMatter:{sidebar_label:"Rendering Blocks",sidebar_position:0,slug:"/gutenberg/rendering-blocks"},sidebar:"tutorialSidebar",previous:{title:"Escaping & Sanitization",permalink:"/docs/learn/utilities/sanitization"},next:{title:"Rendering Custom Blocks",permalink:"/docs/learn/gutenberg/rendering-custom-blocks"}},c={},i=[{value:"Introduction",id:"introduction",level:2},{value:"Naive Approach",id:"naive-approach",level:3},{value:"Blocks as JSON Approach",id:"blocks-as-json-approach",level:3},{value:"Blocks as Markup Approach",id:"blocks-as-markup-approach",level:3},{value:"Which approach should you use?",id:"which-approach-should-you-use",level:3},{value:"The BlocksRenderer component",id:"the-blocksrenderer-component",level:2},{value:"Matching blocks with isBlock",id:"matching-blocks-with-isblock",level:3},{value:"Matching Blocks with isBlockByName",id:"matching-blocks-with-isblockbyname",level:3},{value:"Core Blocks",id:"core-blocks",level:2}],p={toc:i};function d(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,o.Z)({},p,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"rendering-blocks"},"Rendering Blocks"),(0,r.kt)("h2",{id:"introduction"},"Introduction"),(0,r.kt)("p",null,"There are multiple approaches to block rendering"),(0,r.kt)("h3",{id:"naive-approach"},"Naive Approach"),(0,r.kt)("p",null,'Simply output the generated markup "as is", using dangerouslySetInnerHTML.'),(0,r.kt)("h3",{id:"blocks-as-json-approach"},"Blocks as JSON Approach"),(0,r.kt)("p",null,"With this approach, there's some custom PHP logic that parses blocks on the PHP side of things and converts them to JSON to be included in the REST API (or GraphQL). "),(0,r.kt)("p",null,"This approach makes it very easy (and portable) to render blocks anywhere, but on the other hand, it forces the implementation of all supported blocks. Handling server-rendered blocks is also a problem."),(0,r.kt)("p",null,"In this approach, blocks are parsed on the Backend."),(0,r.kt)("h3",{id:"blocks-as-markup-approach"},"Blocks as Markup Approach"),(0,r.kt)("p",null,"Instead of simply outputting the generated markup \u201cas is\u201d, it runs the block markup through an HTML parser (after sanitizing) and selectively (and progressively) replaces block markup with actual React components as needed."),(0,r.kt)("p",null,"This approach is the simplest way to render blocks as not all blocks need to be actual React components (e.g paragraphs, lists, etc). You only need to create React Components for very specific blocks such as Links, Images, and \u201cdynamic blocks\u201d such as accordion, etc. You can still ignore certain blocks if you want better control of supported blocks (both on the WP side and the front-end side)."),(0,r.kt)("p",null,"In this approach, blocks are parsed on the Frontend."),(0,r.kt)("h3",{id:"which-approach-should-you-use"},"Which approach should you use?"),(0,r.kt)("p",null,"The framework supports all of these approaches. However, it does not ship with a \u201cblocks-to-rest\u201d plugin. But nothing is stopping you from shipping your own."),(0,r.kt)("p",null,"Instead, it provides a React API for selectively choosing blocks to be replaced with React components and as we\u2019ll show in this article this approach works well for most content-focused websites and can even be implemented in React Native apps to power App screens fully curated by Gutenberg."),(0,r.kt)("h2",{id:"the-blocksrenderer-component"},"The BlocksRenderer component"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"BlocksRenderer")," component is the heart of the \u201cHTML to React\u201d approach. It receives arbitrary HTML markup, runs its content through wpKsesPost, and replaces markup with react component based on the child components passed to it. This approach is not tied to Gutenberg markup in any way, it can be used as a generic HTML-to-React conversion tool. Here\u2019s a simple example of how it works"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},'const MyLinkBlock = ({ domNode, children }) => {\n // get the html attributes from the dom node\n const { href, rel } = domNode.attribs;\n\n return (\n \n {children}\n \n );\n};\n\nexport const Blocks = ({ html }) => {\n return (\n \n \n \n );\n};\n')),(0,r.kt)("p",null,"In the example above, we\u2019re passing the HTML content directly to BlocksRenderer and we\u2019re specifying that any anchor tags with a class of \u201cmy-special-anchor\u201d should be replaced with MyLinkBlock."),(0,r.kt)("p",null,"The MyLinkBlock then gets one special prop called domNode which is the DOM Node that\u2019s being replaced with a React component. You can use domNode to access attributes of the node such as href and rel in this case."),(0,r.kt)("p",null,"Alternatively, you can also specify a test function to match dom nodes, the example above could also have been written as shown below"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"}," node.type === 'tag' \n && node.name === 'a' \n && node.attribs.class === 'my-special-anchor'\n } \n/>\n")),(0,r.kt)("p",null,"There are a number of utility functions that make matching nodes and blocks specifically very easy as we\u2019ll see now."),(0,r.kt)("h3",{id:"matching-blocks-with-isblock"},"Matching blocks with isBlock"),(0,r.kt)("p",null,"The isBlock function matches a DOM node by its tagName and optionally CSS classes."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"\n isBlock(node, { tagName: 'div', classList: ['block-class-name'] })}\n />\n\n")),(0,r.kt)("h3",{id:"matching-blocks-with-isblockbyname"},"Matching Blocks with isBlockByName"),(0,r.kt)("p",null,"The isBlockByName matches a DOM node by its Gutenberg block name. This function requires the HeadstartWP plugin. The plugin appends two special attributes to every block: ",(0,r.kt)("inlineCode",{parentName:"p"},"data-wp-block-name")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"data-wp-block-attrs"),"."),(0,r.kt)("p",null,"This is a very handy function as it makes it very easy to match any registered Gutenberg block."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"\n isBlock(node, 'core/paragraph')}\n />\n\n")),(0,r.kt)("h2",{id:"core-blocks"},"Core Blocks"),(0,r.kt)("p",null,"Not all core blocks would need to be rendered as React components, but when needed to replace core blocks with react components, the framework provides a set of components that does the heavy lifting of matching core blocks and getting their properties. This set of blocks can be seen here."),(0,r.kt)("p",null,"You can explore how this works by using a debug block component to inspect all of its props. "),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"import {\n BlocksRenderer,\n YoutubeLiteBlock,\n ImageBlock,\n ColumnBlock,\n ColumnsBlock,\n ParagraphBlock,\n DebugBlock,\n} from '@headstartwp/core/react';\n\n\n { /* .... */ }\n \n \n \n\n")),(0,r.kt)("p",null,"You should see something like this\n",(0,r.kt)("img",{alt:"Debug Blocks",src:n(1546).Z,width:"1024",height:"669"})),(0,r.kt)("p",null,"By inspecting the props you can see you have access to things like block name, className, and even the Gutenberg attributes. You could, in theory, build your implementation for every block without loading any of the default Gutenberg styles, shipping your own component library/design system."))}d.isMDXComponent=!0},1546:(e,t,n)=>{n.d(t,{Z:()=>o});const o=n.p+"assets/images/debug-blocks-bcbca3b384a5e56495b121ea85ba5401.png"}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7067],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>k});var o=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var c=o.createContext({}),i=function(e){var t=o.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=i(e.components);return o.createElement(c.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},h=o.forwardRef((function(e,t){var n=e.components,r=e.mdxType,a=e.originalType,c=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),d=i(n),h=r,k=d["".concat(c,".").concat(h)]||d[h]||u[h]||a;return n?o.createElement(k,s(s({ref:t},p),{},{components:n})):o.createElement(k,s({ref:t},p))}));function k(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=n.length,s=new Array(a);s[0]=h;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l[d]="string"==typeof e?e:r,s[1]=l;for(var i=2;i{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>d,frontMatter:()=>a,metadata:()=>l,toc:()=>i});var o=n(7462),r=(n(7294),n(3905));const a={sidebar_label:"Rendering Blocks",sidebar_position:0,slug:"/gutenberg/rendering-blocks"},s="Rendering Blocks",l={unversionedId:"Gutenberg/rendering-blocks",id:"Gutenberg/rendering-blocks",title:"Rendering Blocks",description:"Introduction",source:"@site/documentation/05-Gutenberg/rendering-blocks.md",sourceDirName:"05-Gutenberg",slug:"/gutenberg/rendering-blocks",permalink:"/docs/learn/gutenberg/rendering-blocks",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/05-Gutenberg/rendering-blocks.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1705933854,formattedLastUpdatedAt:"Jan 22, 2024",sidebarPosition:0,frontMatter:{sidebar_label:"Rendering Blocks",sidebar_position:0,slug:"/gutenberg/rendering-blocks"},sidebar:"tutorialSidebar",previous:{title:"Escaping & Sanitization",permalink:"/docs/learn/utilities/sanitization"},next:{title:"Rendering Custom Blocks",permalink:"/docs/learn/gutenberg/rendering-custom-blocks"}},c={},i=[{value:"Introduction",id:"introduction",level:2},{value:"Naive Approach",id:"naive-approach",level:3},{value:"Blocks as JSON Approach",id:"blocks-as-json-approach",level:3},{value:"Blocks as Markup Approach",id:"blocks-as-markup-approach",level:3},{value:"Which approach should you use?",id:"which-approach-should-you-use",level:3},{value:"The BlocksRenderer component",id:"the-blocksrenderer-component",level:2},{value:"Matching blocks with isBlock",id:"matching-blocks-with-isblock",level:3},{value:"Matching Blocks with isBlockByName",id:"matching-blocks-with-isblockbyname",level:3},{value:"Core Blocks",id:"core-blocks",level:2}],p={toc:i};function d(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,o.Z)({},p,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"rendering-blocks"},"Rendering Blocks"),(0,r.kt)("h2",{id:"introduction"},"Introduction"),(0,r.kt)("p",null,"There are multiple approaches to block rendering"),(0,r.kt)("h3",{id:"naive-approach"},"Naive Approach"),(0,r.kt)("p",null,'Simply output the generated markup "as is", using dangerouslySetInnerHTML.'),(0,r.kt)("h3",{id:"blocks-as-json-approach"},"Blocks as JSON Approach"),(0,r.kt)("p",null,"With this approach, there's some custom PHP logic that parses blocks on the PHP side of things and converts them to JSON to be included in the REST API (or GraphQL). "),(0,r.kt)("p",null,"This approach makes it very easy (and portable) to render blocks anywhere, but on the other hand, it forces the implementation of all supported blocks. Handling server-rendered blocks is also a problem."),(0,r.kt)("p",null,"In this approach, blocks are parsed on the Backend."),(0,r.kt)("h3",{id:"blocks-as-markup-approach"},"Blocks as Markup Approach"),(0,r.kt)("p",null,"Instead of simply outputting the generated markup \u201cas is\u201d, it runs the block markup through an HTML parser (after sanitizing) and selectively (and progressively) replaces block markup with actual React components as needed."),(0,r.kt)("p",null,"This approach is the simplest way to render blocks as not all blocks need to be actual React components (e.g paragraphs, lists, etc). You only need to create React Components for very specific blocks such as Links, Images, and \u201cdynamic blocks\u201d such as accordion, etc. You can still ignore certain blocks if you want better control of supported blocks (both on the WP side and the front-end side)."),(0,r.kt)("p",null,"In this approach, blocks are parsed on the Frontend."),(0,r.kt)("h3",{id:"which-approach-should-you-use"},"Which approach should you use?"),(0,r.kt)("p",null,"The framework supports all of these approaches. However, it does not ship with a \u201cblocks-to-rest\u201d plugin. But nothing is stopping you from shipping your own."),(0,r.kt)("p",null,"Instead, it provides a React API for selectively choosing blocks to be replaced with React components and as we\u2019ll show in this article this approach works well for most content-focused websites and can even be implemented in React Native apps to power App screens fully curated by Gutenberg."),(0,r.kt)("h2",{id:"the-blocksrenderer-component"},"The BlocksRenderer component"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"BlocksRenderer")," component is the heart of the \u201cHTML to React\u201d approach. It receives arbitrary HTML markup, runs its content through wpKsesPost, and replaces markup with react component based on the child components passed to it. This approach is not tied to Gutenberg markup in any way, it can be used as a generic HTML-to-React conversion tool. Here\u2019s a simple example of how it works"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},'const MyLinkBlock = ({ domNode, children }) => {\n // get the html attributes from the dom node\n const { href, rel } = domNode.attribs;\n\n return (\n \n {children}\n \n );\n};\n\nexport const Blocks = ({ html }) => {\n return (\n \n \n \n );\n};\n')),(0,r.kt)("p",null,"In the example above, we\u2019re passing the HTML content directly to BlocksRenderer and we\u2019re specifying that any anchor tags with a class of \u201cmy-special-anchor\u201d should be replaced with MyLinkBlock."),(0,r.kt)("p",null,"The MyLinkBlock then gets one special prop called domNode which is the DOM Node that\u2019s being replaced with a React component. You can use domNode to access attributes of the node such as href and rel in this case."),(0,r.kt)("p",null,"Alternatively, you can also specify a test function to match dom nodes, the example above could also have been written as shown below"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"}," node.type === 'tag' \n && node.name === 'a' \n && node.attribs.class === 'my-special-anchor'\n } \n/>\n")),(0,r.kt)("p",null,"There are a number of utility functions that make matching nodes and blocks specifically very easy as we\u2019ll see now."),(0,r.kt)("h3",{id:"matching-blocks-with-isblock"},"Matching blocks with isBlock"),(0,r.kt)("p",null,"The isBlock function matches a DOM node by its tagName and optionally CSS classes."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"\n isBlock(node, { tagName: 'div', classList: ['block-class-name'] })}\n />\n\n")),(0,r.kt)("h3",{id:"matching-blocks-with-isblockbyname"},"Matching Blocks with isBlockByName"),(0,r.kt)("p",null,"The isBlockByName matches a DOM node by its Gutenberg block name. This function requires the HeadstartWP plugin. The plugin appends two special attributes to every block: ",(0,r.kt)("inlineCode",{parentName:"p"},"data-wp-block-name")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"data-wp-block-attrs"),"."),(0,r.kt)("p",null,"This is a very handy function as it makes it very easy to match any registered Gutenberg block."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"\n isBlock(node, 'core/paragraph')}\n />\n\n")),(0,r.kt)("h2",{id:"core-blocks"},"Core Blocks"),(0,r.kt)("p",null,"Not all core blocks would need to be rendered as React components, but when needed to replace core blocks with react components, the framework provides a set of components that does the heavy lifting of matching core blocks and getting their properties. This set of blocks can be seen here."),(0,r.kt)("p",null,"You can explore how this works by using a debug block component to inspect all of its props. "),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"import {\n BlocksRenderer,\n YoutubeLiteBlock,\n ImageBlock,\n ColumnBlock,\n ColumnsBlock,\n ParagraphBlock,\n DebugBlock,\n} from '@headstartwp/core/react';\n\n\n { /* .... */ }\n \n \n \n\n")),(0,r.kt)("p",null,"You should see something like this\n",(0,r.kt)("img",{alt:"Debug Blocks",src:n(1546).Z,width:"1024",height:"669"})),(0,r.kt)("p",null,"By inspecting the props you can see you have access to things like block name, className, and even the Gutenberg attributes. You could, in theory, build your implementation for every block without loading any of the default Gutenberg styles, shipping your own component library/design system."))}d.isMDXComponent=!0},1546:(e,t,n)=>{n.d(t,{Z:()=>o});const o=n.p+"assets/images/debug-blocks-bcbca3b384a5e56495b121ea85ba5401.png"}}]); \ No newline at end of file diff --git a/assets/js/fd4b5c92.4d91bdcd.js b/assets/js/fd4b5c92.e4913e9f.js similarity index 91% rename from assets/js/fd4b5c92.4d91bdcd.js rename to assets/js/fd4b5c92.e4913e9f.js index 5b0d202bb..d73e88ee4 100644 --- a/assets/js/fd4b5c92.4d91bdcd.js +++ b/assets/js/fd4b5c92.e4913e9f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5123],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),c=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(o,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[s]="string"==typeof e?e:n,l[1]=p;for(var c=2;c{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.GroupBlockProps",title:"Interface: GroupBlockProps",sidebar_label:"@headstartwp/core.react.GroupBlockProps",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.GroupBlockProps",id:"interfaces/headstartwp_core.react.GroupBlockProps",title:"Interface: GroupBlockProps",description:"@headstartwp/core.react.GroupBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.GroupBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.GroupBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.GroupBlockProps",title:"Interface: GroupBlockProps",sidebar_label:"@headstartwp/core.react.GroupBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.FileBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},next:{title:"@headstartwp/core.react.GutenbergBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GutenbergBlockProps"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"layout",id:"layout",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"tagName",id:"tagname",level:3},{value:"Defined in",id:"defined-in-8",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".GroupBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"GroupBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"layout"},"layout"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"layout"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"allowOrientation?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"justifyContent?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},'"center"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},'"left"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},'"right"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},'"space-between"'))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"type?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/GroupBlock.tsx#L8"},"packages/core/src/react/blocks/GroupBlock.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/47f868c/packages/core/src/react/blocks/GroupBlock.tsx#L7"},"packages/core/src/react/blocks/GroupBlock.tsx:7")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5123],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),d=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),s=d(a),m=n,h=s["".concat(o,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},c),{},{components:a})):r.createElement(h,l({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[s]="string"==typeof e?e:n,l[1]=p;for(var d=2;d{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.GroupBlockProps",title:"Interface: GroupBlockProps",sidebar_label:"@headstartwp/core.react.GroupBlockProps",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.GroupBlockProps",id:"interfaces/headstartwp_core.react.GroupBlockProps",title:"Interface: GroupBlockProps",description:"@headstartwp/core.react.GroupBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.GroupBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.GroupBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.GroupBlockProps",title:"Interface: GroupBlockProps",sidebar_label:"@headstartwp/core.react.GroupBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.FileBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},next:{title:"@headstartwp/core.react.GutenbergBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GutenbergBlockProps"}},o={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"layout",id:"layout",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"tagName",id:"tagname",level:3},{value:"Defined in",id:"defined-in-8",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".GroupBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"GroupBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"layout"},"layout"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"layout"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"allowOrientation?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"justifyContent?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},'"center"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},'"left"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},'"right"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},'"space-between"'))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"type?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/GroupBlock.tsx#L8"},"packages/core/src/react/blocks/GroupBlock.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/6de8264/packages/core/src/react/blocks/GroupBlock.tsx#L7"},"packages/core/src/react/blocks/GroupBlock.tsx:7")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.504c95af.js b/assets/js/runtime~main.e8e157c5.js similarity index 57% rename from assets/js/runtime~main.504c95af.js rename to assets/js/runtime~main.e8e157c5.js index d6a488ded..29a78158d 100644 --- a/assets/js/runtime~main.504c95af.js +++ b/assets/js/runtime~main.e8e157c5.js @@ -1 +1 @@ -(()=>{"use strict";var e,c,a,f,d,b={},t={};function r(e){var c=t[e];if(void 0!==c)return c.exports;var a=t[e]={exports:{}};return b[e].call(a.exports,a,a.exports,r),a.exports}r.m=b,e=[],r.O=(c,a,f,d)=>{if(!a){var b=1/0;for(i=0;i=d)&&Object.keys(r.O).every((e=>r.O[e](a[o])))?a.splice(o--,1):(t=!1,d0&&e[i-1][2]>d;i--)e[i]=e[i-1];e[i]=[a,f,d]},r.n=e=>{var c=e&&e.__esModule?()=>e.default:()=>e;return r.d(c,{a:c}),c},a=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var d=Object.create(null);r.r(d);var b={};c=c||[null,a({}),a([]),a(a)];for(var t=2&f&&e;"object"==typeof t&&!~c.indexOf(t);t=a(t))Object.getOwnPropertyNames(t).forEach((c=>b[c]=()=>e[c]));return b.default=()=>e,r.d(d,b),d},r.d=(e,c)=>{for(var a in c)r.o(c,a)&&!r.o(e,a)&&Object.defineProperty(e,a,{enumerable:!0,get:c[a]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((c,a)=>(r.f[a](e,c),c)),[])),r.u=e=>"assets/js/"+({26:"37d12b40",53:"935f2afb",62:"d9f3c1c7",157:"2772b305",228:"37ef8e6f",313:"c969edca",520:"66ab7d90",521:"d847ebfc",535:"e9237c6a",607:"a4f5c2b9",669:"042474ac",825:"54d19cbf",856:"c4bf4659",918:"74bdc397",984:"e518cb64",1075:"a304918f",1247:"126717b4",1272:"88a75f53",1362:"912e5e58",1398:"245007dc",1408:"24728c4e",1425:"15509991",1497:"670e912d",1513:"6e83ed71",1552:"3d28897f",1627:"604d33cd",1656:"f46c6fb7",1701:"0a88c552",1726:"6ef049a8",1736:"9c66ae8c",1932:"66decef0",1994:"5667ca25",2069:"6e304a43",2089:"499cbdae",2179:"fae21d27",2201:"20c672e4",2254:"38f0e7b9",2354:"4727697a",2376:"312a1558",2398:"46c017ad",2424:"a0d0f685",2507:"1a87c9a6",2570:"829b8700",2726:"a1514d7c",2779:"704c2a10",2781:"1fbe2079",2849:"016f03e8",2900:"966ac8d5",2925:"0dbccef1",2960:"31d83884",2973:"a56c2626",3021:"01354409",3035:"0065d4a9",3085:"1f391b9e",3126:"44b9bd65",3131:"9be33a19",3133:"58adf8aa",3138:"1937a900",3182:"09153873",3200:"637a3551",3333:"2f847acf",3435:"c75a8848",3446:"173c930b",3514:"ac461116",3533:"0f7b7d82",3586:"55dad7f7",3641:"82691c56",3864:"2e459592",3955:"4c2ded29",4015:"4bfc8e71",4037:"8100c8dc",4038:"c9e017d7",4195:"c4f5d8e4",4222:"a3f5e611",4401:"19a8a98a",4409:"54355d51",4470:"10176796",4504:"d19e169a",4637:"a222760f",4762:"7844975a",4858:"00b96e45",4909:"950ec5f2",5123:"fd4b5c92",5145:"84bf0742",5148:"d87415d1",5182:"7721a5b2",5205:"5fc1d772",5233:"2cb93857",5234:"d9995696",5278:"ef311a1f",5281:"49db3b24",5355:"f2d13ce1",5405:"f3d95041",5534:"4a5e8971",5593:"def27140",5653:"f1627269",5665:"09026ff1",5700:"4e62b870",5787:"5ea6ed43",5835:"2f6d1272",6048:"b29fd792",6217:"4917042f",6303:"30db8841",6307:"ecbd967a",6494:"7742af19",6563:"b2b781c5",6593:"bd37eed7",6623:"e4594716",6741:"4e86766f",6809:"960bca7a",6815:"5bda4233",6875:"7360f818",6971:"c377a04b",7067:"fb675763",7137:"dcac5d89",7148:"a56bba46",7244:"9689b62a",7246:"7d0dd658",7251:"6eeb730f",7253:"8062ea35",7272:"6e8d7793",7307:"37b079cc",7379:"6e3e9c68",7519:"90fd0dd1",7520:"a6407ca9",7625:"cb8267fc",7667:"95bb79e6",7701:"361465a4",7721:"c0c5ccb8",7775:"92bb2d44",7870:"93679912",7895:"7272e25f",7918:"17896441",7920:"1a4e3797",8039:"bdcbc508",8081:"a40ccb42",8089:"e088eb77",8109:"7d4fdb35",8115:"99fcc669",8239:"f78eec9e",8247:"560f4e5a",8327:"4bbbe9cb",8467:"0b387740",8526:"4f5f8bb8",8596:"5e4e234e",8604:"f3283cd4",8673:"9818e328",8743:"eb775807",8950:"4a0d0a3d",8981:"3416b62b",8989:"3b216a90",9050:"0f4f470d",9108:"96b34eb5",9210:"241565db",9236:"cf8aa22f",9256:"b2de5b9f",9379:"3adfa64f",9410:"1efe64df",9514:"1be78505",9530:"4e3c32b5",9589:"5a4180a9",9605:"00a631a6",9621:"76bd5e23",9638:"8872dee1",9673:"35c3fc85",9726:"ae778953",9898:"f9e6d01e",9921:"4bc3bdcd",9953:"cfec6fcb",9956:"c10c719f",9981:"93facf87"}[e]||e)+"."+{26:"a26c08aa",53:"961a5e71",62:"6ff3e65b",157:"dd9d1d46",228:"17f02eb3",272:"c2b5afea",313:"8d2be2f0",520:"3d8098f7",521:"d3bab54b",535:"c343704b",607:"de1d9f66",669:"13dd2180",825:"6ee5e421",856:"7afa5927",918:"87478ed7",984:"bbe73901",1075:"804be197",1247:"3aefb7f7",1272:"f6e2d1b2",1362:"40a40afe",1398:"47a27898",1408:"50d6d344",1425:"021d9b0f",1497:"9a0ba582",1513:"0086750a",1552:"712ecfa4",1627:"504e4a77",1656:"de3efe0e",1701:"7ed47567",1726:"4b0a6f72",1736:"9e67c269",1932:"254e0d92",1994:"d309bce8",2069:"a8d61b25",2089:"3d07fc78",2179:"a875b6ae",2201:"6af35806",2254:"7579e018",2354:"1f0a093a",2376:"d5564eed",2398:"f71f1c7c",2424:"8a6337bb",2507:"191fdd7f",2570:"fc69fa8a",2726:"53eb0878",2779:"f9cc4116",2781:"39f245e9",2849:"b0c86872",2900:"bb9c0fa3",2925:"ea605ee3",2960:"8e63c825",2973:"b57a3f20",3021:"9db09290",3035:"36624222",3085:"12074565",3126:"35d636a8",3131:"74145b3b",3133:"97d03213",3138:"c397d72c",3182:"b51dab69",3200:"faa2cbd3",3333:"31a798ea",3435:"9c549951",3446:"17f8eb48",3514:"13cb382d",3533:"c4ac105a",3586:"e5682b04",3641:"45e75f7e",3864:"2c56b68d",3955:"2f53ad25",4015:"5cee6e5d",4037:"4a78aa83",4038:"c32d1226",4195:"f1e34fa2",4222:"0bad5a08",4401:"3a7590a5",4409:"da54fd73",4470:"390f4775",4504:"203892cd",4637:"b2a1f870",4762:"721e56dd",4858:"ba85b854",4909:"65247023",4972:"61aabc83",5123:"4d91bdcd",5145:"4c5b3e65",5148:"8910ed97",5182:"3536ebd6",5205:"ba14be4e",5233:"bf18b9c7",5234:"8d6e61fc",5278:"c4545799",5281:"d55dc78c",5355:"088b6a2f",5405:"7d8b3329",5525:"4ace2f7d",5534:"b1153eff",5593:"adb6d360",5653:"7148769a",5665:"b11d3066",5700:"93d0d02f",5787:"971c5225",5835:"57402a1d",6048:"7cbff37d",6217:"afe5797a",6303:"a409a86b",6307:"1ccf8935",6494:"02e0a7e5",6563:"2ae54712",6593:"9f076cc3",6623:"a1646846",6741:"204b4194",6809:"49402b10",6815:"ba6d7430",6875:"6f34bbed",6971:"8210b559",7067:"9334f728",7137:"be7d4547",7148:"82d3b457",7244:"cf24f134",7246:"745c010b",7251:"1e34ea0d",7253:"83254880",7272:"7c5d5d59",7307:"22aa4319",7379:"2e90091a",7519:"48dae2b4",7520:"580ba791",7625:"18de701a",7667:"3101d62f",7701:"e98b3406",7721:"22c697da",7775:"8d4d0d22",7870:"7917b00a",7895:"aa3d5c59",7918:"23ae2376",7920:"0c1e7deb",8039:"e061b9f9",8081:"417a4f9b",8089:"e0b0e568",8109:"a425ddea",8115:"6f884d04",8239:"7392531c",8247:"7d2b0ad2",8327:"1e9de729",8443:"47aa84cc",8467:"a48a1893",8526:"9ce1887e",8596:"84845489",8604:"44c665de",8673:"a948eda4",8743:"9566d6f1",8950:"0d95f4db",8981:"f469a224",8989:"9ce89cf7",9050:"c76ec246",9108:"d137e7e1",9210:"ee6d477b",9236:"c78ac3af",9256:"a082ff17",9379:"419fa180",9410:"25fef7d0",9514:"e4f6bea8",9530:"e9a74569",9589:"1739ee3b",9605:"d11f19fc",9621:"b487bb5d",9638:"2574078c",9673:"0845227d",9726:"63597942",9898:"ef97e126",9921:"bcb11960",9953:"87bc1b59",9956:"bcb79b79",9981:"df21442e"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,c)=>Object.prototype.hasOwnProperty.call(e,c),f={},d="headless-doc:",r.l=(e,c,a,b)=>{if(f[e])f[e].push(c);else{var t,o;if(void 0!==a)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var d=f[e];if(delete f[e],t.parentNode&&t.parentNode.removeChild(t),d&&d.forEach((e=>e(a))),c)return c(a)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=l.bind(null,t.onerror),t.onload=l.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.p="/docs/",r.gca=function(e){return e={10176796:"4470",15509991:"1425",17896441:"7918",93679912:"7870","37d12b40":"26","935f2afb":"53",d9f3c1c7:"62","2772b305":"157","37ef8e6f":"228",c969edca:"313","66ab7d90":"520",d847ebfc:"521",e9237c6a:"535",a4f5c2b9:"607","042474ac":"669","54d19cbf":"825",c4bf4659:"856","74bdc397":"918",e518cb64:"984",a304918f:"1075","126717b4":"1247","88a75f53":"1272","912e5e58":"1362","245007dc":"1398","24728c4e":"1408","670e912d":"1497","6e83ed71":"1513","3d28897f":"1552","604d33cd":"1627",f46c6fb7:"1656","0a88c552":"1701","6ef049a8":"1726","9c66ae8c":"1736","66decef0":"1932","5667ca25":"1994","6e304a43":"2069","499cbdae":"2089",fae21d27:"2179","20c672e4":"2201","38f0e7b9":"2254","4727697a":"2354","312a1558":"2376","46c017ad":"2398",a0d0f685:"2424","1a87c9a6":"2507","829b8700":"2570",a1514d7c:"2726","704c2a10":"2779","1fbe2079":"2781","016f03e8":"2849","966ac8d5":"2900","0dbccef1":"2925","31d83884":"2960",a56c2626:"2973","01354409":"3021","0065d4a9":"3035","1f391b9e":"3085","44b9bd65":"3126","9be33a19":"3131","58adf8aa":"3133","1937a900":"3138","09153873":"3182","637a3551":"3200","2f847acf":"3333",c75a8848:"3435","173c930b":"3446",ac461116:"3514","0f7b7d82":"3533","55dad7f7":"3586","82691c56":"3641","2e459592":"3864","4c2ded29":"3955","4bfc8e71":"4015","8100c8dc":"4037",c9e017d7:"4038",c4f5d8e4:"4195",a3f5e611:"4222","19a8a98a":"4401","54355d51":"4409",d19e169a:"4504",a222760f:"4637","7844975a":"4762","00b96e45":"4858","950ec5f2":"4909",fd4b5c92:"5123","84bf0742":"5145",d87415d1:"5148","7721a5b2":"5182","5fc1d772":"5205","2cb93857":"5233",d9995696:"5234",ef311a1f:"5278","49db3b24":"5281",f2d13ce1:"5355",f3d95041:"5405","4a5e8971":"5534",def27140:"5593",f1627269:"5653","09026ff1":"5665","4e62b870":"5700","5ea6ed43":"5787","2f6d1272":"5835",b29fd792:"6048","4917042f":"6217","30db8841":"6303",ecbd967a:"6307","7742af19":"6494",b2b781c5:"6563",bd37eed7:"6593",e4594716:"6623","4e86766f":"6741","960bca7a":"6809","5bda4233":"6815","7360f818":"6875",c377a04b:"6971",fb675763:"7067",dcac5d89:"7137",a56bba46:"7148","9689b62a":"7244","7d0dd658":"7246","6eeb730f":"7251","8062ea35":"7253","6e8d7793":"7272","37b079cc":"7307","6e3e9c68":"7379","90fd0dd1":"7519",a6407ca9:"7520",cb8267fc:"7625","95bb79e6":"7667","361465a4":"7701",c0c5ccb8:"7721","92bb2d44":"7775","7272e25f":"7895","1a4e3797":"7920",bdcbc508:"8039",a40ccb42:"8081",e088eb77:"8089","7d4fdb35":"8109","99fcc669":"8115",f78eec9e:"8239","560f4e5a":"8247","4bbbe9cb":"8327","0b387740":"8467","4f5f8bb8":"8526","5e4e234e":"8596",f3283cd4:"8604","9818e328":"8673",eb775807:"8743","4a0d0a3d":"8950","3416b62b":"8981","3b216a90":"8989","0f4f470d":"9050","96b34eb5":"9108","241565db":"9210",cf8aa22f:"9236",b2de5b9f:"9256","3adfa64f":"9379","1efe64df":"9410","1be78505":"9514","4e3c32b5":"9530","5a4180a9":"9589","00a631a6":"9605","76bd5e23":"9621","8872dee1":"9638","35c3fc85":"9673",ae778953:"9726",f9e6d01e:"9898","4bc3bdcd":"9921",cfec6fcb:"9953",c10c719f:"9956","93facf87":"9981"}[e]||e,r.p+r.u(e)},(()=>{var e={1303:0,532:0};r.f.j=(c,a)=>{var f=r.o(e,c)?e[c]:void 0;if(0!==f)if(f)a.push(f[2]);else if(/^(1303|532)$/.test(c))e[c]=0;else{var d=new Promise(((a,d)=>f=e[c]=[a,d]));a.push(f[2]=d);var b=r.p+r.u(c),t=new Error;r.l(b,(a=>{if(r.o(e,c)&&(0!==(f=e[c])&&(e[c]=void 0),f)){var d=a&&("load"===a.type?"missing":a.type),b=a&&a.target&&a.target.src;t.message="Loading chunk "+c+" failed.\n("+d+": "+b+")",t.name="ChunkLoadError",t.type=d,t.request=b,f[1](t)}}),"chunk-"+c,c)}},r.O.j=c=>0===e[c];var c=(c,a)=>{var f,d,b=a[0],t=a[1],o=a[2],n=0;if(b.some((c=>0!==e[c]))){for(f in t)r.o(t,f)&&(r.m[f]=t[f]);if(o)var i=o(r)}for(c&&c(a);n{"use strict";var e,a,c,f,d,b={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var c=t[e]={exports:{}};return b[e].call(c.exports,c,c.exports,r),c.exports}r.m=b,e=[],r.O=(a,c,f,d)=>{if(!c){var b=1/0;for(i=0;i=d)&&Object.keys(r.O).every((e=>r.O[e](c[o])))?c.splice(o--,1):(t=!1,d0&&e[i-1][2]>d;i--)e[i]=e[i-1];e[i]=[c,f,d]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var d=Object.create(null);r.r(d);var b={};a=a||[null,c({}),c([]),c(c)];for(var t=2&f&&e;"object"==typeof t&&!~a.indexOf(t);t=c(t))Object.getOwnPropertyNames(t).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,r.d(d,b),d},r.d=(e,a)=>{for(var c in a)r.o(a,c)&&!r.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,c)=>(r.f[c](e,a),a)),[])),r.u=e=>"assets/js/"+({26:"37d12b40",53:"935f2afb",62:"d9f3c1c7",157:"2772b305",228:"37ef8e6f",313:"c969edca",520:"66ab7d90",521:"d847ebfc",535:"e9237c6a",607:"a4f5c2b9",669:"042474ac",825:"54d19cbf",856:"c4bf4659",918:"74bdc397",984:"e518cb64",1075:"a304918f",1247:"126717b4",1272:"88a75f53",1362:"912e5e58",1398:"245007dc",1408:"24728c4e",1425:"15509991",1497:"670e912d",1513:"6e83ed71",1552:"3d28897f",1627:"604d33cd",1656:"f46c6fb7",1701:"0a88c552",1726:"6ef049a8",1736:"9c66ae8c",1932:"66decef0",1994:"5667ca25",2069:"6e304a43",2089:"499cbdae",2179:"fae21d27",2201:"20c672e4",2254:"38f0e7b9",2354:"4727697a",2376:"312a1558",2398:"46c017ad",2424:"a0d0f685",2507:"1a87c9a6",2570:"829b8700",2726:"a1514d7c",2779:"704c2a10",2781:"1fbe2079",2849:"016f03e8",2900:"966ac8d5",2925:"0dbccef1",2960:"31d83884",2973:"a56c2626",3021:"01354409",3035:"0065d4a9",3085:"1f391b9e",3126:"44b9bd65",3131:"9be33a19",3133:"58adf8aa",3138:"1937a900",3182:"09153873",3200:"637a3551",3333:"2f847acf",3435:"c75a8848",3446:"173c930b",3514:"ac461116",3533:"0f7b7d82",3586:"55dad7f7",3641:"82691c56",3864:"2e459592",3955:"4c2ded29",4015:"4bfc8e71",4037:"8100c8dc",4038:"c9e017d7",4195:"c4f5d8e4",4222:"a3f5e611",4401:"19a8a98a",4409:"54355d51",4470:"10176796",4504:"d19e169a",4637:"a222760f",4762:"7844975a",4858:"00b96e45",4909:"950ec5f2",5123:"fd4b5c92",5145:"84bf0742",5148:"d87415d1",5182:"7721a5b2",5205:"5fc1d772",5233:"2cb93857",5234:"d9995696",5278:"ef311a1f",5281:"49db3b24",5355:"f2d13ce1",5405:"f3d95041",5534:"4a5e8971",5593:"def27140",5653:"f1627269",5665:"09026ff1",5700:"4e62b870",5787:"5ea6ed43",5835:"2f6d1272",6048:"b29fd792",6217:"4917042f",6303:"30db8841",6307:"ecbd967a",6494:"7742af19",6563:"b2b781c5",6593:"bd37eed7",6623:"e4594716",6741:"4e86766f",6809:"960bca7a",6815:"5bda4233",6875:"7360f818",6971:"c377a04b",7067:"fb675763",7137:"dcac5d89",7148:"a56bba46",7244:"9689b62a",7246:"7d0dd658",7251:"6eeb730f",7253:"8062ea35",7272:"6e8d7793",7307:"37b079cc",7379:"6e3e9c68",7519:"90fd0dd1",7520:"a6407ca9",7625:"cb8267fc",7667:"95bb79e6",7701:"361465a4",7721:"c0c5ccb8",7775:"92bb2d44",7870:"93679912",7895:"7272e25f",7918:"17896441",7920:"1a4e3797",8039:"bdcbc508",8081:"a40ccb42",8089:"e088eb77",8109:"7d4fdb35",8115:"99fcc669",8239:"f78eec9e",8247:"560f4e5a",8327:"4bbbe9cb",8467:"0b387740",8526:"4f5f8bb8",8596:"5e4e234e",8604:"f3283cd4",8673:"9818e328",8743:"eb775807",8950:"4a0d0a3d",8981:"3416b62b",8989:"3b216a90",9050:"0f4f470d",9108:"96b34eb5",9210:"241565db",9236:"cf8aa22f",9256:"b2de5b9f",9379:"3adfa64f",9410:"1efe64df",9514:"1be78505",9530:"4e3c32b5",9589:"5a4180a9",9605:"00a631a6",9621:"76bd5e23",9638:"8872dee1",9673:"35c3fc85",9726:"ae778953",9898:"f9e6d01e",9921:"4bc3bdcd",9953:"cfec6fcb",9956:"c10c719f",9981:"93facf87"}[e]||e)+"."+{26:"82ad1805",53:"961a5e71",62:"11627e4f",157:"c7d93689",228:"b9af90f6",272:"c2b5afea",313:"c6bdf25c",520:"70f5cdd8",521:"6bc109ac",535:"c343704b",607:"8aff1c6a",669:"6372197f",825:"c3ab9b70",856:"719fbaf6",918:"ef3d2d79",984:"7e65a878",1075:"5be855cd",1247:"da4e2884",1272:"72952a9b",1362:"95de57fa",1398:"3c87dac7",1408:"21b35f40",1425:"f47a1013",1497:"b60c023b",1513:"8009d85b",1552:"ed9bc0ce",1627:"504e4a77",1656:"5915df3e",1701:"21c42dfd",1726:"226af2d0",1736:"2b92896f",1932:"6bf62550",1994:"390b42a1",2069:"a5f32711",2089:"9ec183e5",2179:"934a1532",2201:"a49b169d",2254:"16106ab8",2354:"8278edef",2376:"f38c9ca7",2398:"76c046fa",2424:"fb40aa1e",2507:"d09f2bdc",2570:"e48e1ef5",2726:"6d9dc475",2779:"538865f3",2781:"e9c597ef",2849:"47e0b40d",2900:"ba372a6a",2925:"1c1afe51",2960:"2b83a6fb",2973:"0a2d71dc",3021:"e867e768",3035:"0892c98e",3085:"12074565",3126:"dfdcfcf4",3131:"7c04ed84",3133:"e4330035",3138:"c06c3bea",3182:"04c9fc14",3200:"4a61de60",3333:"2e1d39d0",3435:"57239e56",3446:"6f56b54b",3514:"5cd6abbc",3533:"281cf258",3586:"c09dd4db",3641:"55d18aa9",3864:"25c0ab11",3955:"fa6e5012",4015:"90d5ea45",4037:"4a78aa83",4038:"42527c1a",4195:"f1e34fa2",4222:"a30addf5",4401:"4970140a",4409:"7d44666d",4470:"2aca3f03",4504:"f805290d",4637:"b0496467",4762:"b09c5ed4",4858:"dab39b10",4909:"629856cf",4972:"61aabc83",5123:"e4913e9f",5145:"35e23cfb",5148:"0bcf814a",5182:"efd3fd50",5205:"6e1a97be",5233:"65f1c763",5234:"fcc0b3ba",5278:"b9b0ba11",5281:"345b1b7b",5355:"98103ef4",5405:"5de1a48c",5525:"4ace2f7d",5534:"b2122ec9",5593:"fa9c7526",5653:"d0fe9701",5665:"c0799e18",5700:"fafd8cea",5787:"66e253a6",5835:"8e91b8a4",6048:"a503b464",6217:"d759d732",6303:"a409a86b",6307:"fc7951f6",6494:"563b6b70",6563:"772d2060",6593:"78530f2b",6623:"4c67810e",6741:"d7880d47",6809:"61fc22ea",6815:"2368d2b0",6875:"46134336",6971:"8210b559",7067:"18b74a00",7137:"98136835",7148:"f146c7d9",7244:"ce24ba9b",7246:"1d885545",7251:"6b29cf41",7253:"fbdcd301",7272:"8b8330b9",7307:"78ea3a0b",7379:"2e90091a",7519:"fbd0243a",7520:"580ba791",7625:"324fbbbf",7667:"3101d62f",7701:"e98b3406",7721:"37f94642",7775:"102156de",7870:"3d432960",7895:"8e74f7a2",7918:"23ae2376",7920:"0c1e7deb",8039:"23ab3427",8081:"0ae62e0d",8089:"eaf95347",8109:"faed2d7f",8115:"6414049d",8239:"d1316f62",8247:"ce124df2",8327:"fba2d71f",8443:"47aa84cc",8467:"a48a1893",8526:"9ce1887e",8596:"18d30c00",8604:"8148c2ea",8673:"62782006",8743:"a1a3e3cc",8950:"4afa3fa6",8981:"f469a224",8989:"41d44886",9050:"9f672f3a",9108:"06a7e2db",9210:"04469004",9236:"041c0abe",9256:"d3088901",9379:"419fa180",9410:"2bd762a6",9514:"e4f6bea8",9530:"f32d8808",9589:"a4526ed3",9605:"fb4b4afe",9621:"827d15f2",9638:"cadc41e6",9673:"97ca32b4",9726:"1c9d1a65",9898:"243e1eca",9921:"b30cab50",9953:"c01b63b3",9956:"fb727937",9981:"df21442e"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},d="headless-doc:",r.l=(e,a,c,b)=>{if(f[e])f[e].push(a);else{var t,o;if(void 0!==c)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var d=f[e];if(delete f[e],t.parentNode&&t.parentNode.removeChild(t),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=l.bind(null,t.onerror),t.onload=l.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.p="/docs/",r.gca=function(e){return e={10176796:"4470",15509991:"1425",17896441:"7918",93679912:"7870","37d12b40":"26","935f2afb":"53",d9f3c1c7:"62","2772b305":"157","37ef8e6f":"228",c969edca:"313","66ab7d90":"520",d847ebfc:"521",e9237c6a:"535",a4f5c2b9:"607","042474ac":"669","54d19cbf":"825",c4bf4659:"856","74bdc397":"918",e518cb64:"984",a304918f:"1075","126717b4":"1247","88a75f53":"1272","912e5e58":"1362","245007dc":"1398","24728c4e":"1408","670e912d":"1497","6e83ed71":"1513","3d28897f":"1552","604d33cd":"1627",f46c6fb7:"1656","0a88c552":"1701","6ef049a8":"1726","9c66ae8c":"1736","66decef0":"1932","5667ca25":"1994","6e304a43":"2069","499cbdae":"2089",fae21d27:"2179","20c672e4":"2201","38f0e7b9":"2254","4727697a":"2354","312a1558":"2376","46c017ad":"2398",a0d0f685:"2424","1a87c9a6":"2507","829b8700":"2570",a1514d7c:"2726","704c2a10":"2779","1fbe2079":"2781","016f03e8":"2849","966ac8d5":"2900","0dbccef1":"2925","31d83884":"2960",a56c2626:"2973","01354409":"3021","0065d4a9":"3035","1f391b9e":"3085","44b9bd65":"3126","9be33a19":"3131","58adf8aa":"3133","1937a900":"3138","09153873":"3182","637a3551":"3200","2f847acf":"3333",c75a8848:"3435","173c930b":"3446",ac461116:"3514","0f7b7d82":"3533","55dad7f7":"3586","82691c56":"3641","2e459592":"3864","4c2ded29":"3955","4bfc8e71":"4015","8100c8dc":"4037",c9e017d7:"4038",c4f5d8e4:"4195",a3f5e611:"4222","19a8a98a":"4401","54355d51":"4409",d19e169a:"4504",a222760f:"4637","7844975a":"4762","00b96e45":"4858","950ec5f2":"4909",fd4b5c92:"5123","84bf0742":"5145",d87415d1:"5148","7721a5b2":"5182","5fc1d772":"5205","2cb93857":"5233",d9995696:"5234",ef311a1f:"5278","49db3b24":"5281",f2d13ce1:"5355",f3d95041:"5405","4a5e8971":"5534",def27140:"5593",f1627269:"5653","09026ff1":"5665","4e62b870":"5700","5ea6ed43":"5787","2f6d1272":"5835",b29fd792:"6048","4917042f":"6217","30db8841":"6303",ecbd967a:"6307","7742af19":"6494",b2b781c5:"6563",bd37eed7:"6593",e4594716:"6623","4e86766f":"6741","960bca7a":"6809","5bda4233":"6815","7360f818":"6875",c377a04b:"6971",fb675763:"7067",dcac5d89:"7137",a56bba46:"7148","9689b62a":"7244","7d0dd658":"7246","6eeb730f":"7251","8062ea35":"7253","6e8d7793":"7272","37b079cc":"7307","6e3e9c68":"7379","90fd0dd1":"7519",a6407ca9:"7520",cb8267fc:"7625","95bb79e6":"7667","361465a4":"7701",c0c5ccb8:"7721","92bb2d44":"7775","7272e25f":"7895","1a4e3797":"7920",bdcbc508:"8039",a40ccb42:"8081",e088eb77:"8089","7d4fdb35":"8109","99fcc669":"8115",f78eec9e:"8239","560f4e5a":"8247","4bbbe9cb":"8327","0b387740":"8467","4f5f8bb8":"8526","5e4e234e":"8596",f3283cd4:"8604","9818e328":"8673",eb775807:"8743","4a0d0a3d":"8950","3416b62b":"8981","3b216a90":"8989","0f4f470d":"9050","96b34eb5":"9108","241565db":"9210",cf8aa22f:"9236",b2de5b9f:"9256","3adfa64f":"9379","1efe64df":"9410","1be78505":"9514","4e3c32b5":"9530","5a4180a9":"9589","00a631a6":"9605","76bd5e23":"9621","8872dee1":"9638","35c3fc85":"9673",ae778953:"9726",f9e6d01e:"9898","4bc3bdcd":"9921",cfec6fcb:"9953",c10c719f:"9956","93facf87":"9981"}[e]||e,r.p+r.u(e)},(()=>{var e={1303:0,532:0};r.f.j=(a,c)=>{var f=r.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var d=new Promise(((c,d)=>f=e[a]=[c,d]));c.push(f[2]=d);var b=r.p+r.u(a),t=new Error;r.l(b,(c=>{if(r.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var d=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;t.message="Loading chunk "+a+" failed.\n("+d+": "+b+")",t.name="ChunkLoadError",t.type=d,t.request=b,f[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,c)=>{var f,d,b=c[0],t=c[1],o=c[2],n=0;if(b.some((a=>0!==e[a]))){for(f in t)r.o(t,f)&&(r.m[f]=t[f]);if(o)var i=o(r)}for(a&&a(c);n - +

HeadstartWP

Next.js Framework for WordPress

Two hand drawn books with light bulb over them

Documentation

If you are unsure how to do something with the framework, this is where you should start.

Give me the details
Hand drawn papers

API Reference

Browse through the autogenerated TypeScript docs. Find detailed information about every function, class and React components in the framework.

Quick access
Hand drawn light bulb

Framework Principles

If you are curious about why some of decisions behind the framework were made, read the guiding principles for HeadstartWP

Read the philosophy

Finely crafted by 10up, ©2023.

- + \ No newline at end of file diff --git a/learn/Guides/ab-test-link/index.html b/learn/Guides/ab-test-link/index.html index 982acbfe7..d74f3a98a 100644 --- a/learn/Guides/ab-test-link/index.html +++ b/learn/Guides/ab-test-link/index.html @@ -7,13 +7,13 @@ - +
-

A/B Testing SPA vs MPA navigation

In this guide, we’ll implement a custom Link component that will replace every Link in the post content with a custom React component that will implement SPA or MPA navigation based on an A/B test. By “SPA navigation” I mean navigating to other pages via client-side rendering instead of a full-page reload. MPA navigation is the opposite and traditional way of navigation.

This is an interesting use case since there are some claims that MPA might perform better in web vitals compared to SPA (not because it’s necessarily better but because of difficulties to capture some metrics in SPA).

First off, let’s create a custom LinkBlock. We’ll replace the default LinkBlock component with a custom one. Note that the default LinkBlock is a special block implementation that handles internal links for Next.js.

The starter project already has a custom Link component that is passed via dependency injection to the Framework Provider in _app.js. This is essentially telling the framework to use that component whenever rendering a Link.

So the next step here is creating our own “LinkBlock” implementation to use that custom link component.

import { Link } from './Link';

const LinkBlock = ({ domNode, children }) => {
const { href, rel } = getAttributes(domNode.attribs);

return (
<Link href={href} rel={rel}>
{children}
</Link>
);
};

LinkBlock.propTypes = {
domNode: PropTypes.shape({
attribs: PropTypes.shape({}).isRequired,
}).isRequired,
children: PropTypes.node.isRequired,
};

Our custom LinkBlock component leverages the getAttributes utility that receives the domNode attributes and returns an object with available node attributes. You could access attributes directly but this function does some normalization especially around returning className instead of class.

We’ll leverage Next.js middleware for A/B testing. If you’re unfamiliar with Next.js middleware, go read their documentation.

The next step is to open src/middleware.js and make the following changes:

import { AppMiddleware } from '@headstartwp/next/middlewares';
import { NextResponse } from 'next/server';

const COOKIE_NAME = 'bucket-navigation';
const BUCKETS = ['spa', 'mpa'];
const getBucket = () => BUCKETS[Math.floor(Math.random() * BUCKETS.length)];

export async function middleware(req) {
const response = await AppMiddleware(req);

if (!response.redirected) {
const url = req.nextUrl;
const bucket = req.cookies.get(COOKIE_NAME) || getBucket();

response.cookies.set(COOKIE_NAME, bucket);
url.searchParams.set('navigation', bucket);

req.nextUrl.searchParams.set('navigation', bucket);
return NextResponse.rewrite(req.nextUrl, response);
}

return response;
}

Here, we’re simply simulating an A/B test, but you could, in theory, replace getBucket with a call to an A/B testing service. This middleware is essentially adding ?navigation=type to every URL using rewrite which means users won’t actually see that query param in the URL. That provides us with an easy way to check if the current request should be using SPA or MPA for navigation which we’ll do directly in the Link component.

// src/components/Link.js
export const Link = ({ href, rel, children }) => {
const { query } = useRouter();

const settings = useSettings();
const link = removeSourceUrl({ link: href, backendUrl: settings.sourceUrl || '' });

const isSpaNavigation = query?.navigation === 'spa' || typeof query.navigation === 'undefined';

if (isSpaNavigation) {
return (
<NextLink href={link}>
{/* eslint-disable-next-line jsx-a11y/anchor-is-valid */}
<a rel={rel}>{children}</a>
</NextLink>
);
}

return (
<a href={link} rel={rel}>
{children}
</a>
);
};

The changes to this component limit to checking the query object from the router and if the navigation param is equal to “spa” or undefined, in which case it will default to use the Next.js Link component. Otherwise, it defaults to an MPA by simply rendering a regular anchor tag.

Note that the link is converted to a relative link to remove the WordPress domain.

To test this, open a page. Then, check which bucket you’re in

AB Test bucket

In the example above, I was assigned the “mpa” bucket I should see a full page reload when navigating to internal links inside the post content. You can change to the “spa” bucket by modifying the cookie.

AB Test Link

Finely crafted by 10up, ©2023.

- +

A/B Testing SPA vs MPA navigation

In this guide, we’ll implement a custom Link component that will replace every Link in the post content with a custom React component that will implement SPA or MPA navigation based on an A/B test. By “SPA navigation” I mean navigating to other pages via client-side rendering instead of a full-page reload. MPA navigation is the opposite and traditional way of navigation.

This is an interesting use case since there are some claims that MPA might perform better in web vitals compared to SPA (not because it’s necessarily better but because of difficulties to capture some metrics in SPA).

First off, let’s create a custom LinkBlock. We’ll replace the default LinkBlock component with a custom one. Note that the default LinkBlock is a special block implementation that handles internal links for Next.js.

The starter project already has a custom Link component that is passed via dependency injection to the Framework Provider in _app.js. This is essentially telling the framework to use that component whenever rendering a Link.

So the next step here is creating our own “LinkBlock” implementation to use that custom link component.

import { Link } from './Link';

const LinkBlock = ({ domNode, children }) => {
const { href, rel } = getAttributes(domNode.attribs);

return (
<Link href={href} rel={rel}>
{children}
</Link>
);
};

LinkBlock.propTypes = {
domNode: PropTypes.shape({
attribs: PropTypes.shape({}).isRequired,
}).isRequired,
children: PropTypes.node.isRequired,
};

Our custom LinkBlock component leverages the getAttributes utility that receives the domNode attributes and returns an object with available node attributes. You could access attributes directly but this function does some normalization especially around returning className instead of class.

We’ll leverage Next.js middleware for A/B testing. If you’re unfamiliar with Next.js middleware, go read their documentation.

The next step is to open src/middleware.js and make the following changes:

import { AppMiddleware } from '@headstartwp/next/middlewares';
import { NextResponse } from 'next/server';

const COOKIE_NAME = 'bucket-navigation';
const BUCKETS = ['spa', 'mpa'];
const getBucket = () => BUCKETS[Math.floor(Math.random() * BUCKETS.length)];

export async function middleware(req) {
const response = await AppMiddleware(req);

if (!response.redirected) {
const url = req.nextUrl;
const bucket = req.cookies.get(COOKIE_NAME) || getBucket();

response.cookies.set(COOKIE_NAME, bucket);
url.searchParams.set('navigation', bucket);

req.nextUrl.searchParams.set('navigation', bucket);
return NextResponse.rewrite(req.nextUrl, response);
}

return response;
}

Here, we’re simply simulating an A/B test, but you could, in theory, replace getBucket with a call to an A/B testing service. This middleware is essentially adding ?navigation=type to every URL using rewrite which means users won’t actually see that query param in the URL. That provides us with an easy way to check if the current request should be using SPA or MPA for navigation which we’ll do directly in the Link component.

// src/components/Link.js
export const Link = ({ href, rel, children }) => {
const { query } = useRouter();

const settings = useSettings();
const link = removeSourceUrl({ link: href, backendUrl: settings.sourceUrl || '' });

const isSpaNavigation = query?.navigation === 'spa' || typeof query.navigation === 'undefined';

if (isSpaNavigation) {
return (
<NextLink href={link}>
{/* eslint-disable-next-line jsx-a11y/anchor-is-valid */}
<a rel={rel}>{children}</a>
</NextLink>
);
}

return (
<a href={link} rel={rel}>
{children}
</a>
);
};

The changes to this component limit to checking the query object from the router and if the navigation param is equal to “spa” or undefined, in which case it will default to use the Next.js Link component. Otherwise, it defaults to an MPA by simply rendering a regular anchor tag.

Note that the link is converted to a relative link to remove the WordPress domain.

To test this, open a page. Then, check which bucket you’re in

AB Test bucket

In the example above, I was assigned the “mpa” bucket I should see a full page reload when navigating to internal links inside the post content. You can change to the “spa” bucket by modifying the cookie.

AB Test Link

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/Guides/linaria/index.html b/learn/Guides/linaria/index.html index 0d60fc4cb..bff0c35a9 100644 --- a/learn/Guides/linaria/index.html +++ b/learn/Guides/linaria/index.html @@ -7,13 +7,13 @@ - +
-

Linaria (CSS-in-JS)

HeadstartWP offers a straightforward integration with Linaria, a zero-runtime CSS-in-JS solution. To use it, simply install the following linaria packages.

npm install --save-dev @linaria/babel-preset @linaria/core @linaria/react @linaria/shaker @linaria/webpack-loader

The withHeadstartWPConfig function will detect the presence of the Linaria packages and will enable the build steps necessary to compile Linaria.

caution

If you're on a monorepo setup, these packages should be installed on the Next.js project.

Finely crafted by 10up, ©2023.

- +

Linaria (CSS-in-JS)

HeadstartWP offers a straightforward integration with Linaria, a zero-runtime CSS-in-JS solution. To use it, simply install the following linaria packages.

npm install --save-dev @linaria/babel-preset @linaria/core @linaria/react @linaria/shaker @linaria/webpack-loader

The withHeadstartWPConfig function will detect the presence of the Linaria packages and will enable the build steps necessary to compile Linaria.

caution

If you're on a monorepo setup, these packages should be installed on the Next.js project.

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/Guides/typescript/index.html b/learn/Guides/typescript/index.html index 65124e02a..3b8590316 100644 --- a/learn/Guides/typescript/index.html +++ b/learn/Guides/typescript/index.html @@ -7,13 +7,13 @@ - + - +

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/Guides/youtube-facade/index.html b/learn/Guides/youtube-facade/index.html index 5916c7e8a..a6dfc6d04 100644 --- a/learn/Guides/youtube-facade/index.html +++ b/learn/Guides/youtube-facade/index.html @@ -7,13 +7,13 @@ - +
-

Finely crafted by 10up, ©2023.

- +

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/data-fetching/creating-your-own-custom-hooks/index.html b/learn/data-fetching/creating-your-own-custom-hooks/index.html index b32c956f3..d2119f960 100644 --- a/learn/data-fetching/creating-your-own-custom-hooks/index.html +++ b/learn/data-fetching/creating-your-own-custom-hooks/index.html @@ -7,13 +7,13 @@ - +
-

Custom hooks

Sometimes it might be useful to wrap the framework data-fetching hooks into your own hooks.

Creating a custom hook for a custom post type

Let's say you have a custom post type and you want to abstract the parameters needed to get that custom post type. You can create your own hook and pass in the required params.

src/hooks/useBook.js
import { usePost } from '@headstartwp/next';

const defaultParams = {
postType: 'book',
_embed: true,
};

export function useBook(params = {}) {
return usePost({ ...params, ...defaultParams }, options);
}

useBook.fetcher = (sourceUrl?: string) => {
const fetcher = usePost.fetcher(sourceUrl, defaultParams);
return fetcher;
};

That way, you don't need to keep passing around the defaultParams whenever you want to fetch a single book.

By wrapping useBook.fetcher we can also pass a set of default params to the default usePost fetcher function. This ensures that when you use fetchHookData on the server, the data is fetched using the default parameters.

// no need to manually pass `{ params: { postType: 'book' } }
const bookData = await fetchHookData(useBook.fetcher(), context);

This is also useful if you're using TypeScript and your custom post type has additional meta fields.

src/hooks/useBook.ts
import { usePost } from '@headstartwp/next';
import { PostEntity, PostParams } from '@headstartwp/core';

const defaultParams: PostParams = {
postType: 'book',
_embed: true,
};

interface Book extends PostEntity {
isbn: string;
}

export function useBook(params: PostParams | {} = {}) {
return usePost<Book>({ ...params, ...defaultParams }, options);
}

useBook.fetcher = (sourceUrl?: string) => {
const fetcher = usePost.fetcher<Book>(sourceUrl, defaultParams);
return fetcher;
};

Then when using the custom hook isbn will show up as a property of the returned post objects.

Creating your own AppSettings hook

If you're using TypeScript and you are extending the framework's app endpoint and including new fields, you can create your own custom hook and specify the additional TypeScript types.

src/hooks/useMyAppSettings.ts
import { FetchResponse, AppEntity, AppSettingsStrategy } from '@headstartwp/core';
import { FetchHookOptions } from '@headstartwp/core/react';
import { useAppSettings } from '@headstartwp/next';

export interface MyAppSettings extends AppEntity {
my_custom_setting: string;
}

export function useMyAppSettings(
options: FetchHookOptions<FetchResponse<MyAppSettings>> = {},
) {
return useAppSettings<MyAppSettings>({}, options);
}

useMyAppSettings.fetcher = (sourceUrl?: string) =>
new AppSettingsStrategy<MyAppSettings>(sourceUrl);

Custom Strategies

Depending on what you're doing you might need to create a completely custom Fetch Strategy. A Fetch strategy must extend AbstractFetchStrategy and it must contain all of the logic needed to fetch the data.

If you feel like to need to create a custom strategy check out the default Fetch Strategies as well as the hooks that implements them.

Finely crafted by 10up, ©2023.

- +

Custom hooks

Sometimes it might be useful to wrap the framework data-fetching hooks into your own hooks.

Creating a custom hook for a custom post type

Let's say you have a custom post type and you want to abstract the parameters needed to get that custom post type. You can create your own hook and pass in the required params.

src/hooks/useBook.js
import { usePost } from '@headstartwp/next';

const defaultParams = {
postType: 'book',
_embed: true,
};

export function useBook(params = {}) {
return usePost({ ...params, ...defaultParams }, options);
}

useBook.fetcher = (sourceUrl?: string) => {
const fetcher = usePost.fetcher(sourceUrl, defaultParams);
return fetcher;
};

That way, you don't need to keep passing around the defaultParams whenever you want to fetch a single book.

By wrapping useBook.fetcher we can also pass a set of default params to the default usePost fetcher function. This ensures that when you use fetchHookData on the server, the data is fetched using the default parameters.

// no need to manually pass `{ params: { postType: 'book' } }
const bookData = await fetchHookData(useBook.fetcher(), context);

This is also useful if you're using TypeScript and your custom post type has additional meta fields.

src/hooks/useBook.ts
import { usePost } from '@headstartwp/next';
import { PostEntity, PostParams } from '@headstartwp/core';

const defaultParams: PostParams = {
postType: 'book',
_embed: true,
};

interface Book extends PostEntity {
isbn: string;
}

export function useBook(params: PostParams | {} = {}) {
return usePost<Book>({ ...params, ...defaultParams }, options);
}

useBook.fetcher = (sourceUrl?: string) => {
const fetcher = usePost.fetcher<Book>(sourceUrl, defaultParams);
return fetcher;
};

Then when using the custom hook isbn will show up as a property of the returned post objects.

Creating your own AppSettings hook

If you're using TypeScript and you are extending the framework's app endpoint and including new fields, you can create your own custom hook and specify the additional TypeScript types.

src/hooks/useMyAppSettings.ts
import { FetchResponse, AppEntity, AppSettingsStrategy } from '@headstartwp/core';
import { FetchHookOptions } from '@headstartwp/core/react';
import { useAppSettings } from '@headstartwp/next';

export interface MyAppSettings extends AppEntity {
my_custom_setting: string;
}

export function useMyAppSettings(
options: FetchHookOptions<FetchResponse<MyAppSettings>> = {},
) {
return useAppSettings<MyAppSettings>({}, options);
}

useMyAppSettings.fetcher = (sourceUrl?: string) =>
new AppSettingsStrategy<MyAppSettings>(sourceUrl);

Custom Strategies

Depending on what you're doing you might need to create a completely custom Fetch Strategy. A Fetch strategy must extend AbstractFetchStrategy and it must contain all of the logic needed to fetch the data.

If you feel like to need to create a custom strategy check out the default Fetch Strategies as well as the hooks that implements them.

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/data-fetching/index.html b/learn/data-fetching/index.html index 784e9121f..666f2baa7 100644 --- a/learn/data-fetching/index.html +++ b/learn/data-fetching/index.html @@ -7,13 +7,13 @@ - +
-

Introduction

HeadstartWP exposes several customs react hooks that provide a seamless data-fetching experience with WordPress. Those hooks are built to be "isomorphic" i.e can be executed either on the browser or on the server (e.g: Node.js).

The data-fetching logic itself is abstracted by strategies. The custom React hooks are powered by useSwr.

With Next.js app directory support added in Next.js 13, we will be providing special hooks that will work well with Suspense and Streaming. At the moment, we do not recommend using the existing custom hooks in the app directory.

React Custom hooks

The @headstartwp/core/react package export exposes the react hooks implementation on top of the useSwr library. Those hooks are called useFetch* e.g: useFetchPost, useFetchPosts and so on. They can be used outside of Next.js (i.e create-react-app, React Native etc.).

Next.js "bindings"

Next.js is the main meta-framework supported by HeadstartWP, therefore we provide special bindings that make using the framework a breeze.

The Next.js bindings are exposed by the @headstartwp/next package.

The main difference is that the Next.js binding will automatically extract URL segments into request params (i.e extracting post name from the URL automatically) when used in conjunction with the "path" catch-all pattern like src/page/[...path.js].

The following example uses the useFetchPost to manually fetch a page with the about slug.

import { useFetchPost } from '@headstartwp/core/react';

const Page = () => {
const { data: { post }, loading } = useFetchPost({ slug: 'about', post_type: 'page' });

if (loading) {
return 'Loading...';
}

return (<h1>{post.title.rendered}</h1>);
};

You could omit the slug param by specifying the current path of the page and it will parse the path and extract matched params following the WordPress pretty permalinks convention.

usePost({ post_type: 'page' }, {}, '/about');

By using the Next.js bindings and following the path catch-all route convention, the URL extraction is automatic.

src/pages/[...path].js
import { usePost } from '@headstartwp/next';

const Page = () => {
// slug is automatically injected from the next.js router
// if you pass a slug it will override what's coming from the URL
const { loading, error, data } = usePost({ post_type: 'page' });

if (loading) {
return 'Loading...';
}


return (<h1>{post.title.rendered}</h1>);
};

Then visiting a URL like /about or /privacy-policy will render the contents of the about and privacy policy pages respectively.

The remaining of this section will assume the Next.js versions of the hooks are used. It will also assume the "path" catch-all route conventions are being used.

Finely crafted by 10up, ©2023.

- +

Introduction

HeadstartWP exposes several customs react hooks that provide a seamless data-fetching experience with WordPress. Those hooks are built to be "isomorphic" i.e can be executed either on the browser or on the server (e.g: Node.js).

The data-fetching logic itself is abstracted by strategies. The custom React hooks are powered by useSwr.

With Next.js app directory support added in Next.js 13, we will be providing special hooks that will work well with Suspense and Streaming. At the moment, we do not recommend using the existing custom hooks in the app directory.

React Custom hooks

The @headstartwp/core/react package export exposes the react hooks implementation on top of the useSwr library. Those hooks are called useFetch* e.g: useFetchPost, useFetchPosts and so on. They can be used outside of Next.js (i.e create-react-app, React Native etc.).

Next.js "bindings"

Next.js is the main meta-framework supported by HeadstartWP, therefore we provide special bindings that make using the framework a breeze.

The Next.js bindings are exposed by the @headstartwp/next package.

The main difference is that the Next.js binding will automatically extract URL segments into request params (i.e extracting post name from the URL automatically) when used in conjunction with the "path" catch-all pattern like src/page/[...path.js].

The following example uses the useFetchPost to manually fetch a page with the about slug.

import { useFetchPost } from '@headstartwp/core/react';

const Page = () => {
const { data: { post }, loading } = useFetchPost({ slug: 'about', post_type: 'page' });

if (loading) {
return 'Loading...';
}

return (<h1>{post.title.rendered}</h1>);
};

You could omit the slug param by specifying the current path of the page and it will parse the path and extract matched params following the WordPress pretty permalinks convention.

usePost({ post_type: 'page' }, {}, '/about');

By using the Next.js bindings and following the path catch-all route convention, the URL extraction is automatic.

src/pages/[...path].js
import { usePost } from '@headstartwp/next';

const Page = () => {
// slug is automatically injected from the next.js router
// if you pass a slug it will override what's coming from the URL
const { loading, error, data } = usePost({ post_type: 'page' });

if (loading) {
return 'Loading...';
}


return (<h1>{post.title.rendered}</h1>);
};

Then visiting a URL like /about or /privacy-policy will render the contents of the about and privacy policy pages respectively.

The remaining of this section will assume the Next.js versions of the hooks are used. It will also assume the "path" catch-all route conventions are being used.

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/data-fetching/prefetching/index.html b/learn/data-fetching/prefetching/index.html index 66bbbeaa8..566dd92d2 100644 --- a/learn/data-fetching/prefetching/index.html +++ b/learn/data-fetching/prefetching/index.html @@ -7,14 +7,14 @@ - +

Prefetching data on the server

To enable prefetching data on the server use the fetchHookData function alongside addHookData. -We also recommend using the handleError function and to wrap the fetchHookData call in a try/catch.

src/pages/[...path].js
import { 
usePost,
fetchHookData,
addHookData,
handleError
} from '@headstartwp/next';

const params = { postType: ['post', 'page'] };

const SinglePostsPage = () => {
const { data } = usePost(params);

// when doing ssr/ssg data will always be available so handling loading/error state is optional

return (
<div>
<h2>{data?.post.title.rendered}</h2>
</div>
);
};

export default SinglePostsPage;

// or export async function getServerSideProps(context)
export async function getStaticProps(context) {
try {
const usePostHook = await fetchHookData(usePost.fetcher(), context, { params });

return addHookData([usePostHook], { myCustomProp: 'value' });
} catch (e) {
return handleError(e, context);
}
}
  • The fetchHookData function receives a strategy, the Next.js context object and an object containing the params. The params must match the params passed to the hook, hence why it's been moved into a variable outside of the SinglePostsPage component.
  • The addHookData receives an array of responses returned by fetchHookData and prepares that data to be returned to the page as props. If you need to pass additional props just pass them in the second argument.
  • The handleError function handles errors such as 404, redirects (when redirects are set to 404) among other things.

We recommend reviewing the starter project for more examples of prefetching data on the server.

Finely crafted by 10up, ©2023.

- +We also recommend using the handleError function and to wrap the fetchHookData call in a try/catch.

src/pages/[...path].js
import { 
usePost,
fetchHookData,
addHookData,
handleError
} from '@headstartwp/next';

const params = { postType: ['post', 'page'] };

const SinglePostsPage = () => {
const { data } = usePost(params);

// when doing ssr/ssg data will always be available so handling loading/error state is optional

return (
<div>
<h2>{data?.post.title.rendered}</h2>
</div>
);
};

export default SinglePostsPage;

// or export async function getServerSideProps(context)
export async function getStaticProps(context) {
try {
const usePostHook = await fetchHookData(usePost.fetcher(), context, { params });

return addHookData([usePostHook], { myCustomProp: 'value' });
} catch (e) {
return handleError(e, context);
}
}
  • The fetchHookData function receives a strategy, the Next.js context object and an object containing the params. The params must match the params passed to the hook, hence why it's been moved into a variable outside of the SinglePostsPage component.
  • The addHookData receives an array of responses returned by fetchHookData and prepares that data to be returned to the page as props. If you need to pass additional props just pass them in the second argument.
  • The handleError function handles errors such as 404, redirects (when redirects are set to 404) among other things.

We recommend reviewing the starter project for more examples of prefetching data on the server.

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/data-fetching/use-post-or-posts/index.html b/learn/data-fetching/use-post-or-posts/index.html index 9d7183569..b4a09bf28 100644 --- a/learn/data-fetching/use-post-or-posts/index.html +++ b/learn/data-fetching/use-post-or-posts/index.html @@ -7,13 +7,13 @@ - +
-

The usePostOrPosts hook

info

This hook was introduced in @headstartwp/core@1.1.0 and @headstartwp/next@1.1.0

The usePostOrPosts hook is the Next.js binding for the useFetchPostOrPosts.

The usePostOrPosts fetch either a single post or a collection of posts based on the current path. It is useful when you want to prefix the archive and the single posts with the same prefix. E.g: /blog/post-name and /blog/news

Basic Usage

// src/pages/blog/[...path].js

const blogParams = {
single: {
postType: 'post',
},
archive: {
postType: 'post',
taxonomy: 'category',
},
priority: 'single',
routeMatchStrategy: 'single',
};

const Archive = () => {
const { data } = usePosts(blogParams.archive);

return (
<>
<h1>Blog Page</h1>
<ul>
{data.posts.map((post) => (
<li key={post.id}>
<Link href={post.link}>{post.title.rendered}</Link>
</li>
))}
</ul>
</>
);
};

const PageContent = ({ params }) => {
const { data } = usePost(params);

return (
<>
<h1>
<HtmlDecoder html={data.post.title.rendered} />
</h1>
<Blocks html={data.post.content.rendered} />
</>
);
};


const BlogPage = () => {
const { isArchive } = usePostOrPosts(blogParams);

if (isArchive) {
return <Archive />;
}

return <PageContent params={blogParams.single} />;
};

export async function getServerSideProps(context) {
try {
const settledPromises = await resolveBatch([
{
func: fetchHookData(usePostOrPosts.fetcher(), context, { params: blogParams }),
},
]);

return addHookData(settledPromises, {});
} catch (e) {
return handleError(e, context);
}
}

The above route will match the following URLs:

  • /blog/[category]
  • /blog/[category]/page/[page]
  • /blog/[category]/[post-name] (this route will only work if the post.link property matches this structure in WP)
  • /blog/[post-name] (this route will only work if the post.link property matches this structure in WP)

Return values

This hook returns the following things:

  • isArchive: true if the resulting data is for an archive
  • isSingle: true if the resulting data is for a single post
  • post: if isSingle is true, will hold the data for a single post
  • posts: if isArchive is true, will hold the data for an archive

When using the usePostOrPosts hook you can also use usePost and usePosts without needing to make additional fetch calls. The usePostOrPosts hook will populate the cache for usePost and usePosts. That is why in the example on the page, the actual data is pulled from usePost and usePosts.

single and archive params

The route above is going to try to fetch either a single post or a post archive based on the current URL. The parameters passed to single are the usePost parameters and the archive params are the usePosts params.

priority

The possible values for priority are single or archive. This setting exists to prioritize one strategy over the other when there are URL collisions. In the example on this page, there could be a slug collision where a post exists with the slug of a category. In that case, the priority setting will dictate which one is going to be used.

routeMatchStrategy

This setting controls whether [...path].js should match the fetch strategy. The possible values are none (default), single, archive and both.

  • single: Will only fetch a single post if [...path].js matches the structure of a single.
  • archive: Will only fetch an archive if [...path].js matches the structure of an archive.
  • both: Will only fetch a single and an archive if they both match the expected url structure.
  • none: Does not perform any checks against [...path].js.

As an example, if you are trying to have /blog fetch the latest posts and /blog/post-name fetch a single post and set routeMatchStrategy to archive, the /blog route will never work.

Finely crafted by 10up, ©2023.

- +

The usePostOrPosts hook

info

This hook was introduced in @headstartwp/core@1.1.0 and @headstartwp/next@1.1.0

The usePostOrPosts hook is the Next.js binding for the useFetchPostOrPosts.

The usePostOrPosts fetch either a single post or a collection of posts based on the current path. It is useful when you want to prefix the archive and the single posts with the same prefix. E.g: /blog/post-name and /blog/news

Basic Usage

// src/pages/blog/[...path].js

const blogParams = {
single: {
postType: 'post',
},
archive: {
postType: 'post',
taxonomy: 'category',
},
priority: 'single',
routeMatchStrategy: 'single',
};

const Archive = () => {
const { data } = usePosts(blogParams.archive);

return (
<>
<h1>Blog Page</h1>
<ul>
{data.posts.map((post) => (
<li key={post.id}>
<Link href={post.link}>{post.title.rendered}</Link>
</li>
))}
</ul>
</>
);
};

const PageContent = ({ params }) => {
const { data } = usePost(params);

return (
<>
<h1>
<HtmlDecoder html={data.post.title.rendered} />
</h1>
<Blocks html={data.post.content.rendered} />
</>
);
};


const BlogPage = () => {
const { isArchive } = usePostOrPosts(blogParams);

if (isArchive) {
return <Archive />;
}

return <PageContent params={blogParams.single} />;
};

export async function getServerSideProps(context) {
try {
const settledPromises = await resolveBatch([
{
func: fetchHookData(usePostOrPosts.fetcher(), context, { params: blogParams }),
},
]);

return addHookData(settledPromises, {});
} catch (e) {
return handleError(e, context);
}
}

The above route will match the following URLs:

  • /blog/[category]
  • /blog/[category]/page/[page]
  • /blog/[category]/[post-name] (this route will only work if the post.link property matches this structure in WP)
  • /blog/[post-name] (this route will only work if the post.link property matches this structure in WP)

Return values

This hook returns the following things:

  • isArchive: true if the resulting data is for an archive
  • isSingle: true if the resulting data is for a single post
  • post: if isSingle is true, will hold the data for a single post
  • posts: if isArchive is true, will hold the data for an archive

When using the usePostOrPosts hook you can also use usePost and usePosts without needing to make additional fetch calls. The usePostOrPosts hook will populate the cache for usePost and usePosts. That is why in the example on the page, the actual data is pulled from usePost and usePosts.

single and archive params

The route above is going to try to fetch either a single post or a post archive based on the current URL. The parameters passed to single are the usePost parameters and the archive params are the usePosts params.

priority

The possible values for priority are single or archive. This setting exists to prioritize one strategy over the other when there are URL collisions. In the example on this page, there could be a slug collision where a post exists with the slug of a category. In that case, the priority setting will dictate which one is going to be used.

routeMatchStrategy

This setting controls whether [...path].js should match the fetch strategy. The possible values are none (default), single, archive and both.

  • single: Will only fetch a single post if [...path].js matches the structure of a single.
  • archive: Will only fetch an archive if [...path].js matches the structure of an archive.
  • both: Will only fetch a single and an archive if they both match the expected url structure.
  • none: Does not perform any checks against [...path].js.

As an example, if you are trying to have /blog fetch the latest posts and /blog/post-name fetch a single post and set routeMatchStrategy to archive, the /blog route will never work.

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/data-fetching/useSeo/index.html b/learn/data-fetching/useSeo/index.html index c1b0e0fe1..02fd88d6c 100644 --- a/learn/data-fetching/useSeo/index.html +++ b/learn/data-fetching/useSeo/index.html @@ -7,13 +7,13 @@ - +
-

The useSeo hook

info

This hook was introduced in @headstartwp/next@1.1.0

The useSeo hook returns the SEO data for the current page.

Basic Usage

// by default it returns the json object
const yoast_json = useSeo();
const yoast_json = useSeo('json');
// but you can also get the plain html markup for the metadata
const yoast_head = useSeo('html');

If there's no seo information for the current route, this hook will return null therefore we recommend checking for null before using the return value.

Finely crafted by 10up, ©2023.

- +

The useSeo hook

info

This hook was introduced in @headstartwp/next@1.1.0

The useSeo hook returns the SEO data for the current page.

Basic Usage

// by default it returns the json object
const yoast_json = useSeo();
const yoast_json = useSeo('json');
// but you can also get the plain html markup for the metadata
const yoast_head = useSeo('html');

If there's no seo information for the current route, this hook will return null therefore we recommend checking for null before using the return value.

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/data-fetching/useauthorarchive/index.html b/learn/data-fetching/useauthorarchive/index.html index f92369046..733b4251e 100644 --- a/learn/data-fetching/useauthorarchive/index.html +++ b/learn/data-fetching/useauthorarchive/index.html @@ -7,13 +7,13 @@ - +
-

The useAuthorArchive Hook

The useAuthorArchive hook is the Next.js binding for the useFetchAuthorArchive.

The useAuthorArchive hook fetches a collection of WordPress posts from a registered post type filtered by an author.

Basic Usage (Author Archive)

Assuming a src/pages/author/[...path].js route with the following content.

info

This example is using the catch-all route [..path].js because we do not want the /author path to be handled by this route.

src/pages/author/[...path].js
import { useAuthorArchive } from '@headstartwp/next';

const ArchivePage = () => {
const { loading, error, data } = useAuthorArchive({ per_page: 10 });

if (loading) {
return 'Loading...';
}

if (error) {
return 'error...';
}

return (
<div>
{data?.posts?.map((post) => (
<h2 key={post.id}>{post.title.rendered}</h2>
))}
</div>
);
};

The route will automatically render the latest 10 posts from the current author. The following paths will automatically be handled by the hook.

  • /author/author-name
  • /author/author-name/page/2

Author Archive for Custom Post Type

In order to fetch posts from a custom post type, first declare the custom post type in headstartwp.config.js as explained in the headstartwp.config.js section.

src/pages/author/[...path].js
import { useAuthorArchive } from '@headstartwp/next';

const ArchivePage = () => {
// book must be declared in headstartwp.config.js
const { loading, error, data } = useAuthorArchive({ postType: ['book'] });

if (loading) {
return 'Loading...';
}

if (error) {
return 'error...';
}

return (
<div>
{data?.posts?.map((post) => (
<h2 key={post.id}>{post.title.rendered}</h2>
))}
</div>
);
};

Finely crafted by 10up, ©2023.

- +

The useAuthorArchive Hook

The useAuthorArchive hook is the Next.js binding for the useFetchAuthorArchive.

The useAuthorArchive hook fetches a collection of WordPress posts from a registered post type filtered by an author.

Basic Usage (Author Archive)

Assuming a src/pages/author/[...path].js route with the following content.

info

This example is using the catch-all route [..path].js because we do not want the /author path to be handled by this route.

src/pages/author/[...path].js
import { useAuthorArchive } from '@headstartwp/next';

const ArchivePage = () => {
const { loading, error, data } = useAuthorArchive({ per_page: 10 });

if (loading) {
return 'Loading...';
}

if (error) {
return 'error...';
}

return (
<div>
{data?.posts?.map((post) => (
<h2 key={post.id}>{post.title.rendered}</h2>
))}
</div>
);
};

The route will automatically render the latest 10 posts from the current author. The following paths will automatically be handled by the hook.

  • /author/author-name
  • /author/author-name/page/2

Author Archive for Custom Post Type

In order to fetch posts from a custom post type, first declare the custom post type in headstartwp.config.js as explained in the headstartwp.config.js section.

src/pages/author/[...path].js
import { useAuthorArchive } from '@headstartwp/next';

const ArchivePage = () => {
// book must be declared in headstartwp.config.js
const { loading, error, data } = useAuthorArchive({ postType: ['book'] });

if (loading) {
return 'Loading...';
}

if (error) {
return 'error...';
}

return (
<div>
{data?.posts?.map((post) => (
<h2 key={post.id}>{post.title.rendered}</h2>
))}
</div>
);
};

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/data-fetching/usepost/index.html b/learn/data-fetching/usepost/index.html index 41b8e74ed..02919f88f 100644 --- a/learn/data-fetching/usepost/index.html +++ b/learn/data-fetching/usepost/index.html @@ -7,13 +7,13 @@ - +
-

The usePost hook

The usePost hook is the Next.js binding for the useFetchPost.

The usePost hook fetches a single WordPress post from a registered post type. Its basic usage is very simple.

Basic Usage

The basic usage is pretty simple and it assumes a route named src/pages/[...path].js where the slug is extracted from the URL.

src/pages/[...path].js
import { usePost } from '@headstartwp/next';

const PostPage = () => {
const { loading, error, data } = usePost();

if (loading) {
return 'Loading...';
}

if (error) {
return 'error...';
}

return (
<div>
<h2>{data?.post.title.rendered}</h2>
</div>
);
};

Post path matching

caution

The behavior described here was implemented in version 0.5.x of the framework and can be disabled by passing matchCurrentPath: false to usePost (and fetchHookData for server-side data fetching).

The usePost hook will by default match the current path captured by [...path].js with the post's link property. This ensures the right post is loaded and that 404 are issued to unsupported permalinks.

caution

The framework requires that the permalink structure set on the backend matches the URL structure being used on the front-end.

This means that if you include the date in your permalinks the URLs to a post without the date will 404 in the framework.

This is also true for custom post types, if the WordPress backend expects a custom post type to be at /book/book-name the front-end must also follow the same URL structure. If you wish to change the permalink structure for custom post types make sure to make the changes both in WordPress and in your front-end code.

Example where path matches:

  • User visits URL /post-name
  • The post with the post-name slug contains a http://backend.com/post-name link.
  • Since the URL and the path of post.link matches the page/post is rendered.

Example where path does not match:

  • User visits URL /parent-page/post-name
  • The post with the post-name slug contains a http://backend.com/different-parent/post-name url
  • Since the URL (/parent-page/post-name) and the path of post.link (different-parent/post-name) do not match a 404 page is issued.

Example where path does not match but is redirected to the right one:

  • User visits URL /post-name
  • The post with the post-name slug contains a http://backend.com/2022/10/30/post-name url
  • Since the URL and the path of post.link do not match, a NotFound error is thrown
  • If prefetching is setup following pre-fetching and redirectStrategy is set to "404" or "always" in headstartwp.config.js, handleError will then look if there's a redirect available and since WordPress redirects /post-name to /2022/10/30/post-name, the framework will also perform the redirect.

Fetching from multiple post types

When specifying an array of post type, the slug will be searched in both endpoint and the first one to return a valid post object will be used.

caution

This might result in URL conflicts, i.e a post or page using the same slug. The first post type specified will take precedence. In such cases, consider using a different URL structure for each for instance (e.g: using src/pages/article/[...path].js for posts).

src/pages/[...path].js
import { usePost } from '@headstartwp/next';

const PostOrPage = () => {
const { loading, error, data } = usePost({ postType: ['page', 'post'] });

if (loading) {
return 'Loading...';
}

if (error) {
return 'error...';
}

return (
<div>
<h2>{data?.post.title.rendered}</h2>
</div>
);
};

Fetching from a custom post type

To fetch a single from a custom post type, first declare the custom post type in headstartwp.config.js as explained in the headstartwp.config.js section.

src/pages/book/[...path].js
import { usePost } from '@headstartwp/next';

const PostPage = () => {
const { loading, error, data } = usePost({ postType: 'book' });

if (loading) {
return 'Loading...';
}

if (error) {
return 'error...';
}

return (
<div>
<h2>{data?.post.title.rendered}</h2>
</div>
);
};

Finely crafted by 10up, ©2023.

- +

The usePost hook

The usePost hook is the Next.js binding for the useFetchPost.

The usePost hook fetches a single WordPress post from a registered post type. Its basic usage is very simple.

Basic Usage

The basic usage is pretty simple and it assumes a route named src/pages/[...path].js where the slug is extracted from the URL.

src/pages/[...path].js
import { usePost } from '@headstartwp/next';

const PostPage = () => {
const { loading, error, data } = usePost();

if (loading) {
return 'Loading...';
}

if (error) {
return 'error...';
}

return (
<div>
<h2>{data?.post.title.rendered}</h2>
</div>
);
};

Post path matching

caution

The behavior described here was implemented in version 0.5.x of the framework and can be disabled by passing matchCurrentPath: false to usePost (and fetchHookData for server-side data fetching).

The usePost hook will by default match the current path captured by [...path].js with the post's link property. This ensures the right post is loaded and that 404 are issued to unsupported permalinks.

caution

The framework requires that the permalink structure set on the backend matches the URL structure being used on the front-end.

This means that if you include the date in your permalinks the URLs to a post without the date will 404 in the framework.

This is also true for custom post types, if the WordPress backend expects a custom post type to be at /book/book-name the front-end must also follow the same URL structure. If you wish to change the permalink structure for custom post types make sure to make the changes both in WordPress and in your front-end code.

Example where path matches:

  • User visits URL /post-name
  • The post with the post-name slug contains a http://backend.com/post-name link.
  • Since the URL and the path of post.link matches the page/post is rendered.

Example where path does not match:

  • User visits URL /parent-page/post-name
  • The post with the post-name slug contains a http://backend.com/different-parent/post-name url
  • Since the URL (/parent-page/post-name) and the path of post.link (different-parent/post-name) do not match a 404 page is issued.

Example where path does not match but is redirected to the right one:

  • User visits URL /post-name
  • The post with the post-name slug contains a http://backend.com/2022/10/30/post-name url
  • Since the URL and the path of post.link do not match, a NotFound error is thrown
  • If prefetching is setup following pre-fetching and redirectStrategy is set to "404" or "always" in headstartwp.config.js, handleError will then look if there's a redirect available and since WordPress redirects /post-name to /2022/10/30/post-name, the framework will also perform the redirect.

Fetching from multiple post types

When specifying an array of post type, the slug will be searched in both endpoint and the first one to return a valid post object will be used.

caution

This might result in URL conflicts, i.e a post or page using the same slug. The first post type specified will take precedence. In such cases, consider using a different URL structure for each for instance (e.g: using src/pages/article/[...path].js for posts).

src/pages/[...path].js
import { usePost } from '@headstartwp/next';

const PostOrPage = () => {
const { loading, error, data } = usePost({ postType: ['page', 'post'] });

if (loading) {
return 'Loading...';
}

if (error) {
return 'error...';
}

return (
<div>
<h2>{data?.post.title.rendered}</h2>
</div>
);
};

Fetching from a custom post type

To fetch a single from a custom post type, first declare the custom post type in headstartwp.config.js as explained in the headstartwp.config.js section.

src/pages/book/[...path].js
import { usePost } from '@headstartwp/next';

const PostPage = () => {
const { loading, error, data } = usePost({ postType: 'book' });

if (loading) {
return 'Loading...';
}

if (error) {
return 'error...';
}

return (
<div>
<h2>{data?.post.title.rendered}</h2>
</div>
);
};

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/data-fetching/useposts/index.html b/learn/data-fetching/useposts/index.html index a36cbec4d..75b6992dc 100644 --- a/learn/data-fetching/useposts/index.html +++ b/learn/data-fetching/useposts/index.html @@ -7,13 +7,13 @@ - +
-

The usePosts hook

The usePosts hook is the Next.js binding for the useFetchPosts.

The usePosts hook fetches a collection of WordPress posts from a registered post type. Its basic usage is very simple.

Basic Usage

Assuming a src/pages/blog/[[...path]].js route with the following content.

info

This example is using the optional catch-all route [[..path]].js because we want the /blog route to be handled by the same file.

src/pages/blog/[[...path]].js
import { usePost } from '@headstartwp/next';

const ArchivePage = () => {
const { loading, error, data } = usePosts({ per_page: 10 });

if (loading) {
return 'Loading...';
}

if (error) {
return 'error...';
}

return (
<div>
{data?.posts?.map((post) => (
<h2 key={post.id}>{post.title.rendered}</h2>
))}
</div>
);
};

The route will automatically render the latest 10 posts and you get pagination, category, tags and custom taxonomies filtering for free as the following paths will automatically map URL segments into REST API requests:

  • /blog/page/2
  • /blog/category/category-name
  • /blog/tag/tag-name
  • /blog/category/category-name/page/2

Queried Object

The usePosts hook exposes a queriedObject. It's similar to WordPress get_queried_object() function.

It essentially returns what's being queried for, e.g., author or category. If the current page is querying posts within a certain author, then that author object will be populated in data.queriedObject.author. Similarly, if the current page is querying posts from a given category data.queriedObject.term will be populated with that category.

Example:

// category-name can either come from the URL or be manually specified.
const { data } = usePosts({ taxonomy: 'category', category: 'cat-name' });

return (
<h1>Category Page: {data.queriedObject.term.name}</h1>
);

Category Archive

You can use the usePosts hook to create a category archive route (src/pages/category/[...path].js).

info

We use [...path].js here because we do not want the /category route to render anything.

src/pages/category/[...path].js
import {
usePosts,
fetchHookData,
addHookData,
handleError,
} from '@headstartwp/next';

const CategoryPage = () => {
const { data } = usePosts({ taxonomy: 'category' });

return (
<>
<h1>Category Page: {data.queriedObject.term.name}</h1>
<ul>
{data.posts.map((post) => (
<li key={post.id}>
<Link href={post.link}>{post.title.rendered}</Link>
</li>
))}
</ul>
<Pagination pageInfo={data.pageInfo} />
</>
);
};

Archive Path Matching

When using usePosts to create archive pages (e.g. a category archive) you can optionally enable "archive path matching" to ensure that your archive routes match the expected permalink dictated by WordPress. Without "archive path matching", your archive routes would match as long as the last segment of the url is a valid term slug.

For instance, let's take the /category/[...path].js route above. It will match URLs like:

  • /category/cat-name
  • /category/parent-cat-name/cat-name

The framework, however, does not check if parent-cat-name is the de facto parent of cat-name, and even worse, it has no way to know (without additional rest api calls) if parent-cat-name is even a valid category.

To address this, you can pass matchArchivePath to usePosts to tell the framework to check the link property of the queriedObject, i.e if the link property of cat-name returned by the WordPress REST API matches the front-end path.

This setting can also be enabled in headstartwp.config.js globally.

headstartwp.config.js
module.exports = {
// enable archive path mapping for all default taxonomies
customTaxonomies: (defaultTaxonomies) => {
return defaultTaxonomies.map((taxonomy) => ({ ...taxonomy, matchArchivePath: true })),
},
}

Known limitations

  • It is not possible to fetch posts from more than one post type.

Finely crafted by 10up, ©2023.

- +

The usePosts hook

The usePosts hook is the Next.js binding for the useFetchPosts.

The usePosts hook fetches a collection of WordPress posts from a registered post type. Its basic usage is very simple.

Basic Usage

Assuming a src/pages/blog/[[...path]].js route with the following content.

info

This example is using the optional catch-all route [[..path]].js because we want the /blog route to be handled by the same file.

src/pages/blog/[[...path]].js
import { usePost } from '@headstartwp/next';

const ArchivePage = () => {
const { loading, error, data } = usePosts({ per_page: 10 });

if (loading) {
return 'Loading...';
}

if (error) {
return 'error...';
}

return (
<div>
{data?.posts?.map((post) => (
<h2 key={post.id}>{post.title.rendered}</h2>
))}
</div>
);
};

The route will automatically render the latest 10 posts and you get pagination, category, tags and custom taxonomies filtering for free as the following paths will automatically map URL segments into REST API requests:

  • /blog/page/2
  • /blog/category/category-name
  • /blog/tag/tag-name
  • /blog/category/category-name/page/2

Queried Object

The usePosts hook exposes a queriedObject. It's similar to WordPress get_queried_object() function.

It essentially returns what's being queried for, e.g., author or category. If the current page is querying posts within a certain author, then that author object will be populated in data.queriedObject.author. Similarly, if the current page is querying posts from a given category data.queriedObject.term will be populated with that category.

Example:

// category-name can either come from the URL or be manually specified.
const { data } = usePosts({ taxonomy: 'category', category: 'cat-name' });

return (
<h1>Category Page: {data.queriedObject.term.name}</h1>
);

Category Archive

You can use the usePosts hook to create a category archive route (src/pages/category/[...path].js).

info

We use [...path].js here because we do not want the /category route to render anything.

src/pages/category/[...path].js
import {
usePosts,
fetchHookData,
addHookData,
handleError,
} from '@headstartwp/next';

const CategoryPage = () => {
const { data } = usePosts({ taxonomy: 'category' });

return (
<>
<h1>Category Page: {data.queriedObject.term.name}</h1>
<ul>
{data.posts.map((post) => (
<li key={post.id}>
<Link href={post.link}>{post.title.rendered}</Link>
</li>
))}
</ul>
<Pagination pageInfo={data.pageInfo} />
</>
);
};

Archive Path Matching

When using usePosts to create archive pages (e.g. a category archive) you can optionally enable "archive path matching" to ensure that your archive routes match the expected permalink dictated by WordPress. Without "archive path matching", your archive routes would match as long as the last segment of the url is a valid term slug.

For instance, let's take the /category/[...path].js route above. It will match URLs like:

  • /category/cat-name
  • /category/parent-cat-name/cat-name

The framework, however, does not check if parent-cat-name is the de facto parent of cat-name, and even worse, it has no way to know (without additional rest api calls) if parent-cat-name is even a valid category.

To address this, you can pass matchArchivePath to usePosts to tell the framework to check the link property of the queriedObject, i.e if the link property of cat-name returned by the WordPress REST API matches the front-end path.

This setting can also be enabled in headstartwp.config.js globally.

headstartwp.config.js
module.exports = {
// enable archive path mapping for all default taxonomies
customTaxonomies: (defaultTaxonomies) => {
return defaultTaxonomies.map((taxonomy) => ({ ...taxonomy, matchArchivePath: true })),
},
}

Known limitations

  • It is not possible to fetch posts from more than one post type.

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/data-fetching/usesearch/index.html b/learn/data-fetching/usesearch/index.html index f5f25f864..a4758cad4 100644 --- a/learn/data-fetching/usesearch/index.html +++ b/learn/data-fetching/usesearch/index.html @@ -7,13 +7,13 @@ - +
-

The useSearch hook

The useSearch hook is the Next.js binding for the useFetchSearch.

The useSearch hook searches for WordPress posts from a registered post type.

Basic Usage

Assuming a src/pages/search/[[...path]].js route with the following content.

info

This example is using the optional catch-all route [[..path]].js because we want the /search route to be handled by the same file and fetch the latest posts.

src/pages/search/[[...path]].js
import { useSearch } from '@headstartwp/next';

const ArchivePage = () => {
const { loading, error, data } = useSearch({ per_page: 10 });

if (loading) {
return 'Loading...';
}

if (error) {
return 'error...';
}

return (
<div>
{data?.posts?.map((post) => (
<h2 key={post.id}>{post.title.rendered}</h2>
))}
</div>
);
};

The route will automatically render the latest 10 posts if no search term is provided. The following paths are automatically handled:

  • /search/search-term
  • /search/search-term/page/2
  • /search

QueriedObject

The useSearch hook also exposes a queriedObject. See usePosts docs for more info.

The queried object for for this hook is an object of type SearchEntity.

Known limitations

  • It is not possible to fetch posts from more than one post type.

Finely crafted by 10up, ©2023.

- +

The useSearch hook

The useSearch hook is the Next.js binding for the useFetchSearch.

The useSearch hook searches for WordPress posts from a registered post type.

Basic Usage

Assuming a src/pages/search/[[...path]].js route with the following content.

info

This example is using the optional catch-all route [[..path]].js because we want the /search route to be handled by the same file and fetch the latest posts.

src/pages/search/[[...path]].js
import { useSearch } from '@headstartwp/next';

const ArchivePage = () => {
const { loading, error, data } = useSearch({ per_page: 10 });

if (loading) {
return 'Loading...';
}

if (error) {
return 'error...';
}

return (
<div>
{data?.posts?.map((post) => (
<h2 key={post.id}>{post.title.rendered}</h2>
))}
</div>
);
};

The route will automatically render the latest 10 posts if no search term is provided. The following paths are automatically handled:

  • /search/search-term
  • /search/search-term/page/2
  • /search

QueriedObject

The useSearch hook also exposes a queriedObject. See usePosts docs for more info.

The queried object for for this hook is an object of type SearchEntity.

Known limitations

  • It is not possible to fetch posts from more than one post type.

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/data-fetching/useterms/index.html b/learn/data-fetching/useterms/index.html index 94b74196b..474cae9e8 100644 --- a/learn/data-fetching/useterms/index.html +++ b/learn/data-fetching/useterms/index.html @@ -7,13 +7,13 @@ - +
-

Finely crafted by 10up, ©2023.

- +

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/getting-started/headless-config/index.html b/learn/getting-started/headless-config/index.html index 5420e6fbd..34537ed01 100644 --- a/learn/getting-started/headless-config/index.html +++ b/learn/getting-started/headless-config/index.html @@ -7,13 +7,13 @@ - +
-

Configuring the Framework

The headstartwp.config.js (previously, headless.config.js) file contains several config options for HeadstartWP. This file should export an object of type HeadlessConfig.

Usage with Next.js

The file must be named either headstartwp.config.js or headless.config.js. When injectConfig param of withHeadstartWPConfig (previously withHeadlessConfig) is set to true, the framework will look for these two files to be injected and loaded in the runtime bundle of the Next.js App.

next.config.js
const { withHeadstartWPConfig } = require('@headstartwp/next/config');

/**
* Update whatever you need within the nextConfig object.
*
* @type {import('next').NextConfig}
*/
const nextConfig = {};

module.exports = withHeadstartWPConfig(nextConfig);
caution

Since @headstartwp/next@1.2.0 you do not need to import headstartwp.config.js in next.config.js anymore, the framework will dynamically load the config.

Here's a sample config file

headstartwp.config.js
module.exports = {
sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,
hostUrl: process.env.HOST_URL,
customPostTypes: [],
customTaxonomies: [],
redirectStrategy: '404',
useWordPressPlugin: true,
debug: {
redirects: false,
requests: false,
}
};

sourceUrl

The sourceUrl option should point to a valid WordPress installation from where the headless site should be sourced to.

useWordPressPlugin

The useWordPressPlugin indicates whether the WordPress instance at sourceUrl contains the Headless WordPress plugin. While it is possible to use this framework without the plugin, it is strongly recommended to install the WP plugin and set this option to true.

hostUrl

The hostUrl option should contain the value where the frontend app lives. This would typically be the public domain of the site.

host

The host option is automatically inferred if hostUrl is set. You probably don't need to set this option by yourself. The host value is used by the multisite feature to match the current site to a site config.

customPostTypes

To add support for custom post types, add your custom post type to the customPostTypes setting in headstartwp.config.js.

headstartwp.config.js
module.exports = {
sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,
hostUrl: process.env.HOST_URL,
customPostTypes: [
{
slug: 'book',
endpoint: '/wp-json/wp/v2/book',
// these should match your file-system routing
single: '/book',
archive: '/books',
},
],
}

After adding a custom post type to the config, you will be able to fetch posts from the registered post type via the slug:

usePost({ postType: ['book'] });
usePosts({ postType:'book', perPage: 10 });

The single option is required for several things including:

  • properly previewing custom post types when the "single" route is at a different prefix. E.g: /book/da-vince-code instead of /da-vice-code; In this case, the framework will use the single path to redirect the previewed post to the right path/route.
  • Matching post path permalinks with the current URL. E.g: when fetching a single custom post type the framework will filter the returned posts to the one that matches the existing URL. Therefore, the framework needs to know the single prefix url for custom post types. This is required to properly handle parent pages that share the same child slug. See post path mapping for more info.

It is also possible to pass a function, when doing so the default post types (post and pages) will be passed to the function. The code snipped below will disable post path mapping to the default post types.

headstartwp.config.js
module.exports = {
sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,
hostUrl: process.env.HOST_URL,
customPostTypes: (defaultPostTypes) => {
// disable post path mapping for default post types
return defaultPostTypes.map((postType) => ({...postType, matchSinglePath: false}));
}
}

customTaxonomies

To add support for custom taxonomies, add your custom taxonomy to the customTaxonomies setting in headstartwp.config.js.

headstartwp.config.js
module.exports = {
customPostTypes: [
{
slug: 'book',
endpoint: '/wp-json/wp/v2/book',
// these should match your file-system routing
single: '/book',
archive: '/books',
},
],
customTaxonomies: [
{
slug: 'genre',
endpoint: '/wp-json/wp/v2/genre',
postType: ['book'],
rewrite: 'genre',
restParam: 'genre'
},
],
}

After adding a custom taxonomy to the config, you will be able to filter posts by the registered taxonomy or fetch terms from it.

usePost({ postType: ['book'], genre: 'action' });
usePosts({ postType:'book', genre: 'action', perPage: 10 });
useTerms({ taxonomy: 'genre' });

Additionally, if you have an archive route such as /blog or /books filtering for all registered taxonomies works out of the box. For instance, take the headless config above the following page route:

src/pages/books/[[...path]].js
import { usePosts } from '@headstartwp/next';
const BooksPage = () => {
const { data, error, loading } = usePosts({postType: 'book'});

if (error) {
return 'error';
}

if (loading) {
return 'Loading...';
}

return (
<ul>
{data.posts.map((post) => (
<li key={post.id}>{post.title.rendered}</li>
))}
</ul>
);
};

export default BooksPage;

This route would automatically handle the following URLs:

  • /books -> list latest books
  • /books/page/x -> paginate books
  • /books/genre/genre-name -> filter books by genre
  • /books/genre/genre-name/page/2 -> paginate books filtered by genre
caution

The code snippet above does not implement pre-fetching, which you probably want to. Check out the pre-fetching docs for instructions.

It is also possible to specify a function for 'customTaxonomies', when doing so the default taxonomies will be passed to the function. This can be used for instance to enable archive path matching.

headstartwp.config.js
module.exports = {
customPostTypes: [
{
slug: 'book',
endpoint: '/wp-json/wp/v2/book',
// these should match your file-system routing
single: '/book',
archive: '/books',
},
],
customTaxonomies: (defaultTaxonomies) => {
return defaultTaxonomies.map((taxonomy) => ({ ...taxonomy, matchArchivePath: true })),
},
}

restParam

This option shouldn't be necessary most of the time, but this is used to map a custom taxonomy to its REST API parameter. Most of the times the slug is equal to the restParam but in some cases it differs. For instance, the default post tag taxonomy has a slug of post_tag but a restParam of tags (i.e., to filter posts by tags in the REST API, we must use tags=<tag-id>).

rewrite

This option controls the expected prefix the taxonomy must use in front-end urls. This generally should match rewrite.slug of the register_taxonomy function.

redirectStrategy

This option control how redirects are handled. There are 2 supported methods of handling redirects.

  • 404: If a route 404, the framework will check to see if there's a redirect for that page in WP. If so it performs the redirect. This is the recommended option.
  • always: When this option is set, the framework will always check for redirects before rendering any page. Using this option carefully since it will impact performance.

debug

You can enable log debugging for both requests and redirects. debug.requests will enable logging all API requests made by the framework and debug.redirects will log all attempts to detect and fetch a redirect from WordPress.

Finely crafted by 10up, ©2023.

- +

Configuring the Framework

The headstartwp.config.js (previously, headless.config.js) file contains several config options for HeadstartWP. This file should export an object of type HeadlessConfig.

Usage with Next.js

The file must be named either headstartwp.config.js or headless.config.js. When injectConfig param of withHeadstartWPConfig (previously withHeadlessConfig) is set to true, the framework will look for these two files to be injected and loaded in the runtime bundle of the Next.js App.

next.config.js
const { withHeadstartWPConfig } = require('@headstartwp/next/config');

/**
* Update whatever you need within the nextConfig object.
*
* @type {import('next').NextConfig}
*/
const nextConfig = {};

module.exports = withHeadstartWPConfig(nextConfig);
caution

Since @headstartwp/next@1.2.0 you do not need to import headstartwp.config.js in next.config.js anymore, the framework will dynamically load the config.

Here's a sample config file

headstartwp.config.js
module.exports = {
sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,
hostUrl: process.env.HOST_URL,
customPostTypes: [],
customTaxonomies: [],
redirectStrategy: '404',
useWordPressPlugin: true,
debug: {
redirects: false,
requests: false,
}
};

sourceUrl

The sourceUrl option should point to a valid WordPress installation from where the headless site should be sourced to.

useWordPressPlugin

The useWordPressPlugin indicates whether the WordPress instance at sourceUrl contains the Headless WordPress plugin. While it is possible to use this framework without the plugin, it is strongly recommended to install the WP plugin and set this option to true.

hostUrl

The hostUrl option should contain the value where the frontend app lives. This would typically be the public domain of the site.

host

The host option is automatically inferred if hostUrl is set. You probably don't need to set this option by yourself. The host value is used by the multisite feature to match the current site to a site config.

customPostTypes

To add support for custom post types, add your custom post type to the customPostTypes setting in headstartwp.config.js.

headstartwp.config.js
module.exports = {
sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,
hostUrl: process.env.HOST_URL,
customPostTypes: [
{
slug: 'book',
endpoint: '/wp-json/wp/v2/book',
// these should match your file-system routing
single: '/book',
archive: '/books',
},
],
}

After adding a custom post type to the config, you will be able to fetch posts from the registered post type via the slug:

usePost({ postType: ['book'] });
usePosts({ postType:'book', perPage: 10 });

The single option is required for several things including:

  • properly previewing custom post types when the "single" route is at a different prefix. E.g: /book/da-vince-code instead of /da-vice-code; In this case, the framework will use the single path to redirect the previewed post to the right path/route.
  • Matching post path permalinks with the current URL. E.g: when fetching a single custom post type the framework will filter the returned posts to the one that matches the existing URL. Therefore, the framework needs to know the single prefix url for custom post types. This is required to properly handle parent pages that share the same child slug. See post path mapping for more info.

It is also possible to pass a function, when doing so the default post types (post and pages) will be passed to the function. The code snipped below will disable post path mapping to the default post types.

headstartwp.config.js
module.exports = {
sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,
hostUrl: process.env.HOST_URL,
customPostTypes: (defaultPostTypes) => {
// disable post path mapping for default post types
return defaultPostTypes.map((postType) => ({...postType, matchSinglePath: false}));
}
}

customTaxonomies

To add support for custom taxonomies, add your custom taxonomy to the customTaxonomies setting in headstartwp.config.js.

headstartwp.config.js
module.exports = {
customPostTypes: [
{
slug: 'book',
endpoint: '/wp-json/wp/v2/book',
// these should match your file-system routing
single: '/book',
archive: '/books',
},
],
customTaxonomies: [
{
slug: 'genre',
endpoint: '/wp-json/wp/v2/genre',
postType: ['book'],
rewrite: 'genre',
restParam: 'genre'
},
],
}

After adding a custom taxonomy to the config, you will be able to filter posts by the registered taxonomy or fetch terms from it.

usePost({ postType: ['book'], genre: 'action' });
usePosts({ postType:'book', genre: 'action', perPage: 10 });
useTerms({ taxonomy: 'genre' });

Additionally, if you have an archive route such as /blog or /books filtering for all registered taxonomies works out of the box. For instance, take the headless config above the following page route:

src/pages/books/[[...path]].js
import { usePosts } from '@headstartwp/next';
const BooksPage = () => {
const { data, error, loading } = usePosts({postType: 'book'});

if (error) {
return 'error';
}

if (loading) {
return 'Loading...';
}

return (
<ul>
{data.posts.map((post) => (
<li key={post.id}>{post.title.rendered}</li>
))}
</ul>
);
};

export default BooksPage;

This route would automatically handle the following URLs:

  • /books -> list latest books
  • /books/page/x -> paginate books
  • /books/genre/genre-name -> filter books by genre
  • /books/genre/genre-name/page/2 -> paginate books filtered by genre
caution

The code snippet above does not implement pre-fetching, which you probably want to. Check out the pre-fetching docs for instructions.

It is also possible to specify a function for 'customTaxonomies', when doing so the default taxonomies will be passed to the function. This can be used for instance to enable archive path matching.

headstartwp.config.js
module.exports = {
customPostTypes: [
{
slug: 'book',
endpoint: '/wp-json/wp/v2/book',
// these should match your file-system routing
single: '/book',
archive: '/books',
},
],
customTaxonomies: (defaultTaxonomies) => {
return defaultTaxonomies.map((taxonomy) => ({ ...taxonomy, matchArchivePath: true })),
},
}

restParam

This option shouldn't be necessary most of the time, but this is used to map a custom taxonomy to its REST API parameter. Most of the times the slug is equal to the restParam but in some cases it differs. For instance, the default post tag taxonomy has a slug of post_tag but a restParam of tags (i.e., to filter posts by tags in the REST API, we must use tags=<tag-id>).

rewrite

This option controls the expected prefix the taxonomy must use in front-end urls. This generally should match rewrite.slug of the register_taxonomy function.

redirectStrategy

This option control how redirects are handled. There are 2 supported methods of handling redirects.

  • 404: If a route 404, the framework will check to see if there's a redirect for that page in WP. If so it performs the redirect. This is the recommended option.
  • always: When this option is set, the framework will always check for redirects before rendering any page. Using this option carefully since it will impact performance.

debug

You can enable log debugging for both requests and redirects. debug.requests will enable logging all API requests made by the framework and debug.redirects will log all attempts to detect and fetch a redirect from WordPress.

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/getting-started/installing-wordpress-plugin/index.html b/learn/getting-started/installing-wordpress-plugin/index.html index 8713061f6..c997998d0 100644 --- a/learn/getting-started/installing-wordpress-plugin/index.html +++ b/learn/getting-started/installing-wordpress-plugin/index.html @@ -7,13 +7,13 @@ - +
-

Installing WordPress Plugin

The recommended method for installing this plugin is via composer: composer require headstartwp/headstartwp.

Make sure to set up the path for installing this as a WordPress Plugin:

{
"name": "your-vendor-name/your-project-name",
"require": {
"composer/installers": "^1.0",
"headstartwp/headstartwp": "^1.0.0"
},
"extra": {
"installer-paths": {
"plugins/{$name}/": ["type:wordpress-plugin"]
}
},
"config": {
"allow-plugins": {
"composer/installers": true
}
}
}

Manual install

Download the plugin's zip file, manually move it to wp-content/plugins and activate the plugin.

Enter the front-end site URL.

Go to Settings -> General and scroll down until you find the "Headless Frontend URL" and enter the URL for the Headless site.

Plugin settings

Finely crafted by 10up, ©2023.

- +

Installing WordPress Plugin

The recommended method for installing this plugin is via composer: composer require headstartwp/headstartwp.

Make sure to set up the path for installing this as a WordPress Plugin:

{
"name": "your-vendor-name/your-project-name",
"require": {
"composer/installers": "^1.0",
"headstartwp/headstartwp": "^1.0.0"
},
"extra": {
"installer-paths": {
"plugins/{$name}/": ["type:wordpress-plugin"]
}
},
"config": {
"allow-plugins": {
"composer/installers": true
}
}
}

Manual install

Download the plugin's zip file, manually move it to wp-content/plugins and activate the plugin.

Enter the front-end site URL.

Go to Settings -> General and scroll down until you find the "Headless Frontend URL" and enter the URL for the Headless site.

Plugin settings

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/getting-started/quick-setup/index.html b/learn/getting-started/quick-setup/index.html index 285264adc..e65cb8c42 100644 --- a/learn/getting-started/quick-setup/index.html +++ b/learn/getting-started/quick-setup/index.html @@ -7,14 +7,14 @@ - +

Quick Setup

If you're new to Next.js, we recommend reviewing Next.js docs.

System Requirements

  • Node.js 16 or later
  • NPM >= 7
  • WordPress >= 5.9 (prior versions might work but haven't been tested).

Installation

The easiest way to get started with HeadstartWP is by using create-next-app with the official starter project.

npx create-next-app --use-npm -e https://github.com/10up/headstartwp/tree/trunk/projects/wp-nextjs

Then run npm run dev and open http://localhost:3000 in your browser.

Environment Variables

By default, the starter project will point to js1.10up.com. Either change the -NEXT_PUBLIC_HEADLESS_WP_URL variable or create a .env.local file to override the default env variables.

If you're developing locally and using HTTPS with WordPress and you don't have valid certs, you will need to add NODE_TLS_REJECT_UNAUTHORIZED=0 as an env variable

NEXT_PUBLIC_HEADLESS_WP_URL=https://wordpress.test
NODE_TLS_REJECT_UNAUTHORIZED=0

Something Missing?

If something is missing in the documentation or if you found some part confusing, please file an issue for the documentation repository with your suggestions for improvement.

Finely crafted by 10up, ©2023.

- +NEXT_PUBLIC_HEADLESS_WP_URL variable or create a .env.local file to override the default env variables.

If you're developing locally and using HTTPS with WordPress and you don't have valid certs, you will need to add NODE_TLS_REJECT_UNAUTHORIZED=0 as an env variable

NEXT_PUBLIC_HEADLESS_WP_URL=https://wordpress.test
NODE_TLS_REJECT_UNAUTHORIZED=0

Something Missing?

If something is missing in the documentation or if you found some part confusing, please file an issue for the documentation repository with your suggestions for improvement.

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/getting-started/quick-tutorial/index.html b/learn/getting-started/quick-tutorial/index.html index 8a77d5a1a..fb5f71d9d 100644 --- a/learn/getting-started/quick-tutorial/index.html +++ b/learn/getting-started/quick-tutorial/index.html @@ -7,13 +7,13 @@ - +
-

Quick Introduction to the Framework

Introduction

If you’re familiar with Next.js you probably already know that it has a file-system-based router. The routes are declared under the src/pages folder. To learn more about Next.js routing, read the official docs.

the app folder is currently not supported by HeadstartWP. Support for new Next.js 13 features, including the app directory, are underway.

HeadstartWP takes advantage of Next.js routing by leveraging a feature called “catch-all routes” which allows the framework to automatically map URL segments to WordPress routes and the proper REST API parameters necessary to fetch the appropriate data. It does so by adopting a convention of using a “catch-all” route named [...path].js or [[...path]].js.

How Routing Works

To understand how routing works in the framework, let’s take a look at the route in the starter project (src/pages/[...path].js) that corresponds to a single post/page template (single.php) in WordPress.

First, note that it is using single brackets and not double brackets. That is because we only want to “catch” that route if no other top-level route is matched (such as index.js). Therefore, any route in the form of /post-name or /2022/10/1 will match src/[...path].js. You can confirm this by opening any post by either the /post-name route or the date route depending on how your permalinks settings are set up in WordPress E.g:

The great thing about this is that you don’t need multiple Next.js routes to handle the same resource!

Basic Data Fetching

Now let’s look at how data fetching for this route works. To make things easier to understand, let’s disregard getStaticPaths and getStaticProps functions.

src/params.js
/**
* @type {import('@headstartwp/core').PostParams}
*/
export const singleParams = { postType: ['page', 'post'] };
src/pages/[...path].js
import { usePost } from '@headstartwp/next';

const SinglePostsPage = () => {
const { loading, error } = usePost(singleParams);

if (loading) {
return 'Loading...';
}

if (error) {
return 'error...';
}

return (
<div>
<PageContent params={singleParams} />
</div>
);
};

At this point, the page is not rendered on the server (or at build time) at all. Therefore this route is behaving like a single-page application.

The usePost hook is one of the framework's data-fetching hooks. As its name suggests it fetches a single post for a given set of params. We’re passing one param called postType, which is telling the hook to fetch the current page from either the "page" or "post" post type. Note that we're not passing the slug. Passing the slug is optional and if you don't pass the slug, the framework will automatically extract the post/page slug from the URL, if present.

Extracting the slug from the url only works when using the [...path].js or [[...path]].js catch-all route style.

SPA Data Fetching

Without server-side data fetching, the experience gets clunky and web vitals are greatly affected as there will be a high CLS. SEO is also affected since there is no content or SEO meta tags until the browser fetches the data.

The framework data fetching layer is “isomorphic”, you start with client-side data fetching and then opt-in for data that must be pre-fetched on the server. There are a few benefits of this approach:

  • It’s possible to easily switch between pre-fetched and non-prefetched data
  • You can pre-fetch on the server and re-fetch on the client, for instance, you might want to re-fetch the "most recent posts" block on the homepage.
  • Mitigate prop-drilling, no need to pass post props to every component as you can simply call the custom hooks (as long as the params match what's being queried for).

It is important to note that you should always pre-fetch on the server the “main query” and/or the “core” data for a page in a headless site. That’s what we’ll do next! Keep the getStaticPaths function commented out and uncomment getStaticProps.

src/pages/[...path].js
export async function getStaticProps(context) {
try {

const settledPromises = await resolveBatch([
{
func: fetchHookData(usePost.fetcher(), context, { params: singleParams }),
},
{ func: fetchHookData(useAppSettings.fetcher(), context), throw: false },
]);

return addHookData(settledPromises, { revalidate: 5 * 60 });
} catch (e) {
return handleError(e, context);
}
}

getStaticProps is a Next.js method used when you want to pre-render a page on the server at build time or on-demand via ISR.

To enable pre-rendering of this route all we need to do is pre-fetch all of the data needed for the framework’s custom hooks. There are two hooks we need to pre-fetch data for, usePost and useAppSettings. The useAppSettings hook is responsible for fetching general settings and menu data. The Nav.js component depends on useAppSettings and if we don’t pre-fetch data for it, the menu will be fetched on the client side only.

The function responsible for pre-fetching data is fetchHookData. It accepts the following params:

  • A fetcher strategy that you can get via usePost.fetcher()
  • The next.js context. It is used to extract parameters from the URL among other things.
  • An object containing the params. The params must match the params being used by the hooks, otherwise, there will be a key mismatch and data would be pre-fetched for the wrong set of params.

The resolveBatch function is just a utility function that lets you run multiple promises in parallel and select which ones you don’t want to throw errors for. In this case, we’re ignoring the error potentially thrown by useAppSettings.fetcher() the reason being that this hook requires the Headless WordPress plugin, and therefore disabling that plugin would cause a crash on the site if we don’t ignore errors thrown by useAppSettings.fetcher(). Ultimately, it is up to your to decide how to handle errors, we just give you the tools to make your job easier.

Next, we have the addHookData function which expects an array of "hook data" (i.e pre-fetched data for the custom hooks returned by fetchHookData). The addHookData will simply put the results on the cache and hydrate the custom hook with pre-fetched data. The second param is an object that represents the Next.js props you can return from getStaticProps or getServerSideProps.

If anything fails, we call the handleError function which provides standard error handling such as rendering a 404 page if a page is not found and optionally handling redirects (if the redirect strategy is set to 404 in headstartwp.config.js).

Lastly, the getStaticPaths will return an array of paths that should be pre-rendered at build time. This should only be used in conjunction with getStaticProps. Note that the framework doesn’t force getStaticProps you can use getServerSideProps (especially if your hosting doesn’t provide good support for ISR).

One benefit of pre-rendering (a subset of your pages) at build time is that it can catch a lot of runtime issues since undefined/type errors among others would be caught at build time in your CI.

Main Query, Queried Object, and SEO handling.

At this point, you might be wondering how the framework handles SEO integration. It does so by using the yoast_head (or yoast_head_json object) added by the Yoast plugin to every resource in the REST API. It works for both single pages and archive pages. The yoast_head_json from either the main query or the queried object is used to populate the page’s meta tags.

The "Main Query" is the query that draws parameters from the URL. For example, in src/pages/[...path].js, the usePost is the main query since it extracts parameters from the URL. Therefore the yoast_head_json associated with the resource returned by usePost is used to populate the page's SEO meta tags. This allows for additional data to be fetched with other custom hooks without messing with the SEO meta tags for the page.

For instance, you might want to display an array of related posts at the bottom of the single post template, since this doesn’t represent the "main query" of the page it won’t be used to populate the page's SEO meta tags.

There’s also the concept of "queried object" which is very similar to get_queried_object() function in WP. It returns the resource that is being "queried for". For instance, in a category archive page, the queried object represents the category that's being queried for.

Let's take a look at src/pages/category/[...path].js

src/pages/category/[...path].js
import { usePosts } from '@headstartwp/next';

const CategoryPage = () => {
const { data } = usePosts({ taxonomy: 'category' });

return (
<>
<h1>Category Page: {data.queriedObject.term.name}</h1>
<ul>
{data.posts.map((post) => (
<li key={post.id}>
<Link href={post.link}>{post.title.rendered}</Link>
</li>
))}
</ul>
<Pagination pageInfo={data.pageInfo} />
</>
);
};

In this route, we're fetching a list of posts that belong to the category taxonomy. Note that again, we're not passing the category slug, it’s automatically inferred by the framework.

Since we’re querying posts that belong to a specific category, data.queriedObject is available with a term object representing the queried category. You will note that this route follows the same "pattern" from src/[...path].js.

Take some time to review the other routes, did you spot the pattern?

  • Fetch data on the client using the framework’s custom hooks
  • Pre-fetch the data on the server matching the params object.

Should you handle loading/error states on the client?

As you might have noticed, the category route is not handling errors and loading states on the client. Therefore it assumes the data will always be pre-fetched on the server. If you remove getServerSideProps, you will see the following error.

data-error

At 10up, we strongly believe that a great developer experience increases developer productivity! Therefore the framework will try to help you, the developer, as much as it can.

In this case, it "detects" that you’re trying to access something that's returned by the custom hook but is not yet available. As the error message suggests, you need to either handle the loading/error states or pre-fetch the data on the server. We didn't see this error on the single post route because loading/error states are being handled on that route!

So as long as you're pre-fetching data on the server you do not need to handle loading/error states on the client.

One way to make things more consistent and your code more resilient without directly handling loading states is by using Suspense, however, that is not fully supported in Next.js and the framework itself (but it will!).

Finely crafted by 10up, ©2023.

- +

Quick Introduction to the Framework

Introduction

If you’re familiar with Next.js you probably already know that it has a file-system-based router. The routes are declared under the src/pages folder. To learn more about Next.js routing, read the official docs.

the app folder is currently not supported by HeadstartWP. Support for new Next.js 13 features, including the app directory, are underway.

HeadstartWP takes advantage of Next.js routing by leveraging a feature called “catch-all routes” which allows the framework to automatically map URL segments to WordPress routes and the proper REST API parameters necessary to fetch the appropriate data. It does so by adopting a convention of using a “catch-all” route named [...path].js or [[...path]].js.

How Routing Works

To understand how routing works in the framework, let’s take a look at the route in the starter project (src/pages/[...path].js) that corresponds to a single post/page template (single.php) in WordPress.

First, note that it is using single brackets and not double brackets. That is because we only want to “catch” that route if no other top-level route is matched (such as index.js). Therefore, any route in the form of /post-name or /2022/10/1 will match src/[...path].js. You can confirm this by opening any post by either the /post-name route or the date route depending on how your permalinks settings are set up in WordPress E.g:

The great thing about this is that you don’t need multiple Next.js routes to handle the same resource!

Basic Data Fetching

Now let’s look at how data fetching for this route works. To make things easier to understand, let’s disregard getStaticPaths and getStaticProps functions.

src/params.js
/**
* @type {import('@headstartwp/core').PostParams}
*/
export const singleParams = { postType: ['page', 'post'] };
src/pages/[...path].js
import { usePost } from '@headstartwp/next';

const SinglePostsPage = () => {
const { loading, error } = usePost(singleParams);

if (loading) {
return 'Loading...';
}

if (error) {
return 'error...';
}

return (
<div>
<PageContent params={singleParams} />
</div>
);
};

At this point, the page is not rendered on the server (or at build time) at all. Therefore this route is behaving like a single-page application.

The usePost hook is one of the framework's data-fetching hooks. As its name suggests it fetches a single post for a given set of params. We’re passing one param called postType, which is telling the hook to fetch the current page from either the "page" or "post" post type. Note that we're not passing the slug. Passing the slug is optional and if you don't pass the slug, the framework will automatically extract the post/page slug from the URL, if present.

Extracting the slug from the url only works when using the [...path].js or [[...path]].js catch-all route style.

SPA Data Fetching

Without server-side data fetching, the experience gets clunky and web vitals are greatly affected as there will be a high CLS. SEO is also affected since there is no content or SEO meta tags until the browser fetches the data.

The framework data fetching layer is “isomorphic”, you start with client-side data fetching and then opt-in for data that must be pre-fetched on the server. There are a few benefits of this approach:

  • It’s possible to easily switch between pre-fetched and non-prefetched data
  • You can pre-fetch on the server and re-fetch on the client, for instance, you might want to re-fetch the "most recent posts" block on the homepage.
  • Mitigate prop-drilling, no need to pass post props to every component as you can simply call the custom hooks (as long as the params match what's being queried for).

It is important to note that you should always pre-fetch on the server the “main query” and/or the “core” data for a page in a headless site. That’s what we’ll do next! Keep the getStaticPaths function commented out and uncomment getStaticProps.

src/pages/[...path].js
export async function getStaticProps(context) {
try {

const settledPromises = await resolveBatch([
{
func: fetchHookData(usePost.fetcher(), context, { params: singleParams }),
},
{ func: fetchHookData(useAppSettings.fetcher(), context), throw: false },
]);

return addHookData(settledPromises, { revalidate: 5 * 60 });
} catch (e) {
return handleError(e, context);
}
}

getStaticProps is a Next.js method used when you want to pre-render a page on the server at build time or on-demand via ISR.

To enable pre-rendering of this route all we need to do is pre-fetch all of the data needed for the framework’s custom hooks. There are two hooks we need to pre-fetch data for, usePost and useAppSettings. The useAppSettings hook is responsible for fetching general settings and menu data. The Nav.js component depends on useAppSettings and if we don’t pre-fetch data for it, the menu will be fetched on the client side only.

The function responsible for pre-fetching data is fetchHookData. It accepts the following params:

  • A fetcher strategy that you can get via usePost.fetcher()
  • The next.js context. It is used to extract parameters from the URL among other things.
  • An object containing the params. The params must match the params being used by the hooks, otherwise, there will be a key mismatch and data would be pre-fetched for the wrong set of params.

The resolveBatch function is just a utility function that lets you run multiple promises in parallel and select which ones you don’t want to throw errors for. In this case, we’re ignoring the error potentially thrown by useAppSettings.fetcher() the reason being that this hook requires the Headless WordPress plugin, and therefore disabling that plugin would cause a crash on the site if we don’t ignore errors thrown by useAppSettings.fetcher(). Ultimately, it is up to your to decide how to handle errors, we just give you the tools to make your job easier.

Next, we have the addHookData function which expects an array of "hook data" (i.e pre-fetched data for the custom hooks returned by fetchHookData). The addHookData will simply put the results on the cache and hydrate the custom hook with pre-fetched data. The second param is an object that represents the Next.js props you can return from getStaticProps or getServerSideProps.

If anything fails, we call the handleError function which provides standard error handling such as rendering a 404 page if a page is not found and optionally handling redirects (if the redirect strategy is set to 404 in headstartwp.config.js).

Lastly, the getStaticPaths will return an array of paths that should be pre-rendered at build time. This should only be used in conjunction with getStaticProps. Note that the framework doesn’t force getStaticProps you can use getServerSideProps (especially if your hosting doesn’t provide good support for ISR).

One benefit of pre-rendering (a subset of your pages) at build time is that it can catch a lot of runtime issues since undefined/type errors among others would be caught at build time in your CI.

Main Query, Queried Object, and SEO handling.

At this point, you might be wondering how the framework handles SEO integration. It does so by using the yoast_head (or yoast_head_json object) added by the Yoast plugin to every resource in the REST API. It works for both single pages and archive pages. The yoast_head_json from either the main query or the queried object is used to populate the page’s meta tags.

The "Main Query" is the query that draws parameters from the URL. For example, in src/pages/[...path].js, the usePost is the main query since it extracts parameters from the URL. Therefore the yoast_head_json associated with the resource returned by usePost is used to populate the page's SEO meta tags. This allows for additional data to be fetched with other custom hooks without messing with the SEO meta tags for the page.

For instance, you might want to display an array of related posts at the bottom of the single post template, since this doesn’t represent the "main query" of the page it won’t be used to populate the page's SEO meta tags.

There’s also the concept of "queried object" which is very similar to get_queried_object() function in WP. It returns the resource that is being "queried for". For instance, in a category archive page, the queried object represents the category that's being queried for.

Let's take a look at src/pages/category/[...path].js

src/pages/category/[...path].js
import { usePosts } from '@headstartwp/next';

const CategoryPage = () => {
const { data } = usePosts({ taxonomy: 'category' });

return (
<>
<h1>Category Page: {data.queriedObject.term.name}</h1>
<ul>
{data.posts.map((post) => (
<li key={post.id}>
<Link href={post.link}>{post.title.rendered}</Link>
</li>
))}
</ul>
<Pagination pageInfo={data.pageInfo} />
</>
);
};

In this route, we're fetching a list of posts that belong to the category taxonomy. Note that again, we're not passing the category slug, it’s automatically inferred by the framework.

Since we’re querying posts that belong to a specific category, data.queriedObject is available with a term object representing the queried category. You will note that this route follows the same "pattern" from src/[...path].js.

Take some time to review the other routes, did you spot the pattern?

  • Fetch data on the client using the framework’s custom hooks
  • Pre-fetch the data on the server matching the params object.

Should you handle loading/error states on the client?

As you might have noticed, the category route is not handling errors and loading states on the client. Therefore it assumes the data will always be pre-fetched on the server. If you remove getServerSideProps, you will see the following error.

data-error

At 10up, we strongly believe that a great developer experience increases developer productivity! Therefore the framework will try to help you, the developer, as much as it can.

In this case, it "detects" that you’re trying to access something that's returned by the custom hook but is not yet available. As the error message suggests, you need to either handle the loading/error states or pre-fetch the data on the server. We didn't see this error on the single post route because loading/error states are being handled on that route!

So as long as you're pre-fetching data on the server you do not need to handle loading/error states on the client.

One way to make things more consistent and your code more resilient without directly handling loading states is by using Suspense, however, that is not fully supported in Next.js and the framework itself (but it will!).

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/getting-started/setting-up-manually/index.html b/learn/getting-started/setting-up-manually/index.html index 7050a3cfc..b713311c5 100644 --- a/learn/getting-started/setting-up-manually/index.html +++ b/learn/getting-started/setting-up-manually/index.html @@ -7,13 +7,13 @@ - +
-

Setting up the framework from scratch

The recommended way to get started with the framework is by installing the official starter project. See Quick Setup for more information.

This guide will help you set up the framework in a clean Next.js project.

Bootstrap the Next.js project

Start by bootstrapping your next.js project.

npx create-next-app@latest --use-npm

and install the following packages

npm install --save @headstartwp/core @headstartwp/next

headstartwp.config.js

Create a headstartwp.config.js file at the root of your Next.js project.

headstartwp.config.js
/**
* Headless Config
*
* @type {import('@headstartwp/core').HeadlessConfig}
*/
module.exports = {
sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,

useWordPressPlugin: true,
};

Env variables

Then create a .env (or .env.local) with the following contents:

NEXT_PUBLIC_HEADLESS_WP_URL=https://my-wordpress.test

You can call the env variable anything you want, just make sure to update headstartwp.config.js accordingly.

If you're developing locally and your WordPress instance uses https but does not have a valid cert, add NODE_TLS_REJECT_UNAUTHORIZED=0 to your env variables.

next.config.js

Create a next.config.js file with the following contents:

next.config.js
const { withHeadstartWPConfig } = require('@headstartwp/next/config');

/**
* Update whatever you need within the nextConfig object.
*
* @type {import('next').NextConfig}
*/
const nextConfig = {};

module.exports = withHeadstartWPConfig(nextConfig);

pages/_app.js

Create a custom _app.js to wrap the application with HeadlessApp component.

src/pages/_app.js
import { HeadlessApp } from '@headstartwp/next';
import Link from 'next/link';
import Router from 'next/router';

import '../styles.css';

const MyApp = ({ Component, pageProps }) => {
// only HeadlessApp needs fallback and themeJson, so we remove them from the props we pass down to the pages

// eslint-disable-next-line react/prop-types, no-unused-vars
const { fallback = {}, themeJson = {}, ...props } = pageProps;

return (
<HeadlessApp
pageProps={pageProps}
settings={{
// instruct the framework to use Next.js link component or your own version
linkComponent: Link,
}}
>
<Component {...props} />
</HeadlessApp>
);
};

export default MyApp;

Setting up the preview endpoint

The WordPress plugin expects the preview endpoint to be located at /api/preview.

To enable support for previews, create a src/pages/api/preview.js with the following contents:

src/pages/api/preview.js
import { previewHandler } from '@headstartwp/next';

/**
* The Preview endpoint just needs to proxy the default preview handler
*
* @param {*} req Next.js request object
* @param {*} res Next.js response object
*
* @returns
*/
export default async function handler(req, res) {
return previewHandler(req, res);
}

Setting up the revalidate endpoint

The framework supports ISR revalidation triggered by WordPress. To enable ISR revalidate, make sure you have the WordPress plugin enabled and activate the option in WordPress settings.

ISR Option

Then add the revalidateHandler to src/pages/api/revalidate.js

src/pages/api/revalidate.js
import { revalidateHandler } from '@headstartwp/next';

/**
* The revalidate endpoint just needs to proxy the default revalidate handler
*
* @param {*} req Next.js request object
* @param {*} res Next.js response object
*
* @returns
*/
export default async function handler(req, res) {
return revalidateHandler(req, res);
}

Creating your first route

To make sure everything is working as expected create a catch-all route called pages/[...path].js. This route will be responsible for rendering single post and pages.

By creating a [...path].js route, the framework will automatically detect and extract URL parameters from the path argument.

src/pages/[...path].js
import {
usePost,
fetchHookData,
addHookData,
handleError,
usePosts
} from '@headstartwp/next';
import { BlocksRenderer } from '@headstartwp/core/react';

const params = { postType: ['post', 'page' ] };

const SinglePostsPage = () => {
const { loading, error, data } = usePost(params);

if (loading) {
return 'Loading...';
}

if (error) {
return 'error...';
}

return (
<div>
<h1>{data.post.title.rendered}</h1>
<BlocksRenderer html={data.post.content.rendered} />
</div>
);
};

export default SinglePostsPage;

Then, visit any single post or page, e.g: http://localhost:3000/hello-world and you should see both the title and the content of that post/page.

Date URLs will also work: e.g: http://localhost:3000/2022/10/2/hello-world

Add SSR/SSG

With the example above, you might have noticed that the data is only being fetched on the client. You must use one of the Next.js data fetching methods to enable SSR/SSG.

Add this to the pages/[...path].js file

src/pages/[...path].js
// or export async function getServerSideProps(context)
export async function getStaticProps(context) {
try {
// make sure to pass the same params to fetchHookData and usePost
const usePostData = await fetchHookData(usePost.fetcher(), context, { params });

return addHookData([usePostData], {});
} catch (e) {
return handleError(e, context);
}
}

Then refresh the page and voilá! Data is now being fetched on the server.

Finely crafted by 10up, ©2023.

- +

Setting up the framework from scratch

The recommended way to get started with the framework is by installing the official starter project. See Quick Setup for more information.

This guide will help you set up the framework in a clean Next.js project.

Bootstrap the Next.js project

Start by bootstrapping your next.js project.

npx create-next-app@latest --use-npm

and install the following packages

npm install --save @headstartwp/core @headstartwp/next

headstartwp.config.js

Create a headstartwp.config.js file at the root of your Next.js project.

headstartwp.config.js
/**
* Headless Config
*
* @type {import('@headstartwp/core').HeadlessConfig}
*/
module.exports = {
sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,

useWordPressPlugin: true,
};

Env variables

Then create a .env (or .env.local) with the following contents:

NEXT_PUBLIC_HEADLESS_WP_URL=https://my-wordpress.test

You can call the env variable anything you want, just make sure to update headstartwp.config.js accordingly.

If you're developing locally and your WordPress instance uses https but does not have a valid cert, add NODE_TLS_REJECT_UNAUTHORIZED=0 to your env variables.

next.config.js

Create a next.config.js file with the following contents:

next.config.js
const { withHeadstartWPConfig } = require('@headstartwp/next/config');

/**
* Update whatever you need within the nextConfig object.
*
* @type {import('next').NextConfig}
*/
const nextConfig = {};

module.exports = withHeadstartWPConfig(nextConfig);

pages/_app.js

Create a custom _app.js to wrap the application with HeadlessApp component.

src/pages/_app.js
import { HeadlessApp } from '@headstartwp/next';
import Link from 'next/link';
import Router from 'next/router';

import '../styles.css';

const MyApp = ({ Component, pageProps }) => {
// only HeadlessApp needs fallback and themeJson, so we remove them from the props we pass down to the pages

// eslint-disable-next-line react/prop-types, no-unused-vars
const { fallback = {}, themeJson = {}, ...props } = pageProps;

return (
<HeadlessApp
pageProps={pageProps}
settings={{
// instruct the framework to use Next.js link component or your own version
linkComponent: Link,
}}
>
<Component {...props} />
</HeadlessApp>
);
};

export default MyApp;

Setting up the preview endpoint

The WordPress plugin expects the preview endpoint to be located at /api/preview.

To enable support for previews, create a src/pages/api/preview.js with the following contents:

src/pages/api/preview.js
import { previewHandler } from '@headstartwp/next';

/**
* The Preview endpoint just needs to proxy the default preview handler
*
* @param {*} req Next.js request object
* @param {*} res Next.js response object
*
* @returns
*/
export default async function handler(req, res) {
return previewHandler(req, res);
}

Setting up the revalidate endpoint

The framework supports ISR revalidation triggered by WordPress. To enable ISR revalidate, make sure you have the WordPress plugin enabled and activate the option in WordPress settings.

ISR Option

Then add the revalidateHandler to src/pages/api/revalidate.js

src/pages/api/revalidate.js
import { revalidateHandler } from '@headstartwp/next';

/**
* The revalidate endpoint just needs to proxy the default revalidate handler
*
* @param {*} req Next.js request object
* @param {*} res Next.js response object
*
* @returns
*/
export default async function handler(req, res) {
return revalidateHandler(req, res);
}

Creating your first route

To make sure everything is working as expected create a catch-all route called pages/[...path].js. This route will be responsible for rendering single post and pages.

By creating a [...path].js route, the framework will automatically detect and extract URL parameters from the path argument.

src/pages/[...path].js
import {
usePost,
fetchHookData,
addHookData,
handleError,
usePosts
} from '@headstartwp/next';
import { BlocksRenderer } from '@headstartwp/core/react';

const params = { postType: ['post', 'page' ] };

const SinglePostsPage = () => {
const { loading, error, data } = usePost(params);

if (loading) {
return 'Loading...';
}

if (error) {
return 'error...';
}

return (
<div>
<h1>{data.post.title.rendered}</h1>
<BlocksRenderer html={data.post.content.rendered} />
</div>
);
};

export default SinglePostsPage;

Then, visit any single post or page, e.g: http://localhost:3000/hello-world and you should see both the title and the content of that post/page.

Date URLs will also work: e.g: http://localhost:3000/2022/10/2/hello-world

Add SSR/SSG

With the example above, you might have noticed that the data is only being fetched on the client. You must use one of the Next.js data fetching methods to enable SSR/SSG.

Add this to the pages/[...path].js file

src/pages/[...path].js
// or export async function getServerSideProps(context)
export async function getStaticProps(context) {
try {
// make sure to pass the same params to fetchHookData and usePost
const usePostData = await fetchHookData(usePost.fetcher(), context, { params });

return addHookData([usePostData], {});
} catch (e) {
return handleError(e, context);
}
}

Then refresh the page and voilá! Data is now being fetched on the server.

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/gutenberg/rendering-blocks-in-react-native/index.html b/learn/gutenberg/rendering-blocks-in-react-native/index.html index fc84cc577..1e6891844 100644 --- a/learn/gutenberg/rendering-blocks-in-react-native/index.html +++ b/learn/gutenberg/rendering-blocks-in-react-native/index.html @@ -7,13 +7,13 @@ - +
-

Rendering Blocks in React Native

Introduction

The BlocksRenderer component can also be used to render Gutenberg blocks in React Native, by rendering blocks to native components without using a webview.

The examples in this section are part of a demo react native expo hosted on the headless-expo repo. This Demo app uses expo and the HeadstartWP to fetch a page and render Gutenberg blocks as react-native components.

All of the code for this demo app lives in App.js. Since the demo app is using the data-fetching hooks from the core package, we first need to wrap the App with the SettingsProvider component.

export default function App() {
return (
<SettingsProvider>
<View style={styles.container}>
<StatusBar style="auto" />
<SinglePostComponent />
</View>
</SettingsProvider>
);
}

We also need to inject the headless config. For now, we need to use a workaround to inject the headless config.

import headlessConfig from "./headless.config";

globalThis.__10up__HEADLESS_CONFIG = { ...headlessConfig };

Blocks Rendering

The SinglePostComponent is the one that fetches a page and render its content

function SinglePostComponent() {
const { loading, data } = useFetchPost({
postType: "page",
slug: "react-native-test",
});

if (loading) {
return <Text>Loading...</Text>;
}

return (
<BlocksRenderer html={data.post.content.rendered}>
<ParagraphBlock component={RNParagraphBlock} />
<HeadingBlock component={RNHeadingBlock} />
<ImageBlock component={RNImageBlock} />
<RawText />
<EmptyBlock />
</BlocksRenderer>
);
}

useFetchPost is the core implementation of the usePost. The next.js hooks are built on top of the core data-fetching hooks. The core data-fetching hooks can be used in any react environment. In this example, we’re fetching a page, with a slug called "react-native-test".

This is all we need to have a React Native app that fetches data from a WP instance. The next step is building out the Block components.

We’ll start with EmptyBlock and RawText. We need to be very careful when rendering blocks in React Native as we can’t render any text under a React Native View component and remember that we’re not rendering this under a webview, we are rendering blocks as native components.

Since we can’t render blocks that haven’t been implemented by us yet, we’ll create an allowed block list! We’ll do that in the EmptyBlock component.

/**
* A noop block
*
* You can also use this to create a "allowList" of blocks and ignore blocks you don't want to render
*
* @returns
*/
const EmptyBlock = () => <></>;

EmptyBlock.defaultProps = {
/**
* Essentially catches any empty text nodes to make sure they don't get rendered under a <View> component
*
* @param {*} node
* @returns
*/
test: (node) => {
const allowedBlocks = ["core/paragraph", "core/heading", "core/image"];

// if this isn't an allowed block catch it
// if this is an allowed block it should have been handled at this ppint
if (
node.type !== "text" &&
!allowedBlocks.some((blockName) => isBlockByName(node, blockName))
) {
return true;
}

return (
node.type === "text" &&
(node.parent === null || node.data?.trim().length === 0)
);
},
};

The goal of the EmptyBlock is to catch all non-allowed blocks and skip rendering them at all. Additionally, it also catches orphan text nodes that only contain whitespaces (this would catch things carriage returns, spacing around tags, etc…)

Note that we’re using defaultProps to provide the test function. This has the same result of passing the test function as a prop directly.

The next step is implementing a RawText component.

/**
* Trims raw text nodes
*
* @param {*} param0
* @returns
*/
const RawText = ({ domNode }) => {
return domNode.data.trim();
};

RawText.defaultProps = {
/**
* Catches any non-orphans and non-empty text fields
*
* @param {*} node
* @returns
*/
test: (node) =>
node.type === "text" &&
node.parent !== null &&
node.data?.trim().length >= 0,
};

The goal here is to trim all text nodes. This is mostly to clean up text nodes. Therefore, we catch any non-orphans and non-empty text field nodes and replace them with a "trimmed" version.

Now we have ensured that we don’t have lingering text nodes and that valid text node does not contain additional whitespaces at the beginning and end.

Paragraph Block

Implementing the Paragraph block is pretty simple. All we need to do is use the React Native Text component

import { /* ... */, Text} from "react-native";

const RNParagraphBlock = ({ children }) => {
return <Text>{children}</Text>;
};

Note that this is essentially replacing the "p" tag with a native "Text" component. "children" in this context represent text nodes that are processed via the "RawText" block. If we didn’t render children here, RawText block would never be executed for this paragraph. It’s recursive logic!

Heading Block

The heading block is very similar, we leverage the "level" prop that’s automatically passed by the HeadingBlock component. We use it to create a dynamic class name that contains the style for the heading.

import { /* ... */, Text} from "react-native";

const RNHeadingBlock = ({ children, level }) => {
return <Text style={styles[`headingLevel${level}`]}>{children}</Text>;
};

const styles = StyleSheet.create({
container: {
flex: 1,
backgroundColor: "#fff",
alignItems: "center",
justifyContent: "center",
},
headingLevel1: {
fontWeight: "bold",
fontSize: "26px",
},
headingLevel2: {
fontWeight: "bold",
fontSize: "20px",
},
});

Image Block

The last block we’ll implement is the image block. It is a bit more complex but it first captures the image caption by looping through the DOM node children until it finds a "figcaption" Then it uses the "height", "width" and "src" props that are automatically passed by the ImageBlock component to render the image using the native "Image" component.

import { /* ... */, Image, Text} from "react-native";

const RNImageBlock = ({ domNode, height, width, src }) => {
const caption =
domNode.children.find((el) => el.name === "figcaption")?.firstChild?.data ??
"";
return (
<>
<Image
style={[{ width: width, height: height }]}
source={{
uri: src,
}}
/>
<Text>{caption}</Text>
</>
);
};

Result

The demo app should render something like this

Blocks App

Finely crafted by 10up, ©2023.

- +

Rendering Blocks in React Native

Introduction

The BlocksRenderer component can also be used to render Gutenberg blocks in React Native, by rendering blocks to native components without using a webview.

The examples in this section are part of a demo react native expo hosted on the headless-expo repo. This Demo app uses expo and the HeadstartWP to fetch a page and render Gutenberg blocks as react-native components.

All of the code for this demo app lives in App.js. Since the demo app is using the data-fetching hooks from the core package, we first need to wrap the App with the SettingsProvider component.

export default function App() {
return (
<SettingsProvider>
<View style={styles.container}>
<StatusBar style="auto" />
<SinglePostComponent />
</View>
</SettingsProvider>
);
}

We also need to inject the headless config. For now, we need to use a workaround to inject the headless config.

import headlessConfig from "./headless.config";

globalThis.__10up__HEADLESS_CONFIG = { ...headlessConfig };

Blocks Rendering

The SinglePostComponent is the one that fetches a page and render its content

function SinglePostComponent() {
const { loading, data } = useFetchPost({
postType: "page",
slug: "react-native-test",
});

if (loading) {
return <Text>Loading...</Text>;
}

return (
<BlocksRenderer html={data.post.content.rendered}>
<ParagraphBlock component={RNParagraphBlock} />
<HeadingBlock component={RNHeadingBlock} />
<ImageBlock component={RNImageBlock} />
<RawText />
<EmptyBlock />
</BlocksRenderer>
);
}

useFetchPost is the core implementation of the usePost. The next.js hooks are built on top of the core data-fetching hooks. The core data-fetching hooks can be used in any react environment. In this example, we’re fetching a page, with a slug called "react-native-test".

This is all we need to have a React Native app that fetches data from a WP instance. The next step is building out the Block components.

We’ll start with EmptyBlock and RawText. We need to be very careful when rendering blocks in React Native as we can’t render any text under a React Native View component and remember that we’re not rendering this under a webview, we are rendering blocks as native components.

Since we can’t render blocks that haven’t been implemented by us yet, we’ll create an allowed block list! We’ll do that in the EmptyBlock component.

/**
* A noop block
*
* You can also use this to create a "allowList" of blocks and ignore blocks you don't want to render
*
* @returns
*/
const EmptyBlock = () => <></>;

EmptyBlock.defaultProps = {
/**
* Essentially catches any empty text nodes to make sure they don't get rendered under a <View> component
*
* @param {*} node
* @returns
*/
test: (node) => {
const allowedBlocks = ["core/paragraph", "core/heading", "core/image"];

// if this isn't an allowed block catch it
// if this is an allowed block it should have been handled at this ppint
if (
node.type !== "text" &&
!allowedBlocks.some((blockName) => isBlockByName(node, blockName))
) {
return true;
}

return (
node.type === "text" &&
(node.parent === null || node.data?.trim().length === 0)
);
},
};

The goal of the EmptyBlock is to catch all non-allowed blocks and skip rendering them at all. Additionally, it also catches orphan text nodes that only contain whitespaces (this would catch things carriage returns, spacing around tags, etc…)

Note that we’re using defaultProps to provide the test function. This has the same result of passing the test function as a prop directly.

The next step is implementing a RawText component.

/**
* Trims raw text nodes
*
* @param {*} param0
* @returns
*/
const RawText = ({ domNode }) => {
return domNode.data.trim();
};

RawText.defaultProps = {
/**
* Catches any non-orphans and non-empty text fields
*
* @param {*} node
* @returns
*/
test: (node) =>
node.type === "text" &&
node.parent !== null &&
node.data?.trim().length >= 0,
};

The goal here is to trim all text nodes. This is mostly to clean up text nodes. Therefore, we catch any non-orphans and non-empty text field nodes and replace them with a "trimmed" version.

Now we have ensured that we don’t have lingering text nodes and that valid text node does not contain additional whitespaces at the beginning and end.

Paragraph Block

Implementing the Paragraph block is pretty simple. All we need to do is use the React Native Text component

import { /* ... */, Text} from "react-native";

const RNParagraphBlock = ({ children }) => {
return <Text>{children}</Text>;
};

Note that this is essentially replacing the "p" tag with a native "Text" component. "children" in this context represent text nodes that are processed via the "RawText" block. If we didn’t render children here, RawText block would never be executed for this paragraph. It’s recursive logic!

Heading Block

The heading block is very similar, we leverage the "level" prop that’s automatically passed by the HeadingBlock component. We use it to create a dynamic class name that contains the style for the heading.

import { /* ... */, Text} from "react-native";

const RNHeadingBlock = ({ children, level }) => {
return <Text style={styles[`headingLevel${level}`]}>{children}</Text>;
};

const styles = StyleSheet.create({
container: {
flex: 1,
backgroundColor: "#fff",
alignItems: "center",
justifyContent: "center",
},
headingLevel1: {
fontWeight: "bold",
fontSize: "26px",
},
headingLevel2: {
fontWeight: "bold",
fontSize: "20px",
},
});

Image Block

The last block we’ll implement is the image block. It is a bit more complex but it first captures the image caption by looping through the DOM node children until it finds a "figcaption" Then it uses the "height", "width" and "src" props that are automatically passed by the ImageBlock component to render the image using the native "Image" component.

import { /* ... */, Image, Text} from "react-native";

const RNImageBlock = ({ domNode, height, width, src }) => {
const caption =
domNode.children.find((el) => el.name === "figcaption")?.firstChild?.data ??
"";
return (
<>
<Image
style={[{ width: width, height: height }]}
source={{
uri: src,
}}
/>
<Text>{caption}</Text>
</>
);
};

Result

The demo app should render something like this

Blocks App

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/gutenberg/rendering-blocks/index.html b/learn/gutenberg/rendering-blocks/index.html index 0074b5fe6..68d182f06 100644 --- a/learn/gutenberg/rendering-blocks/index.html +++ b/learn/gutenberg/rendering-blocks/index.html @@ -7,14 +7,14 @@ - +

Rendering Blocks

Introduction

There are multiple approaches to block rendering

Naive Approach

Simply output the generated markup "as is", using dangerouslySetInnerHTML.

Blocks as JSON Approach

With this approach, there's some custom PHP logic that parses blocks on the PHP side of things and converts them to JSON to be included in the REST API (or GraphQL).

This approach makes it very easy (and portable) to render blocks anywhere, but on the other hand, it forces the implementation of all supported blocks. Handling server-rendered blocks is also a problem.

In this approach, blocks are parsed on the Backend.

Blocks as Markup Approach

Instead of simply outputting the generated markup “as is”, it runs the block markup through an HTML parser (after sanitizing) and selectively (and progressively) replaces block markup with actual React components as needed.

This approach is the simplest way to render blocks as not all blocks need to be actual React components (e.g paragraphs, lists, etc). You only need to create React Components for very specific blocks such as Links, Images, and “dynamic blocks” such as accordion, etc. You can still ignore certain blocks if you want better control of supported blocks (both on the WP side and the front-end side).

In this approach, blocks are parsed on the Frontend.

Which approach should you use?

The framework supports all of these approaches. However, it does not ship with a “blocks-to-rest” plugin. But nothing is stopping you from shipping your own.

Instead, it provides a React API for selectively choosing blocks to be replaced with React components and as we’ll show in this article this approach works well for most content-focused websites and can even be implemented in React Native apps to power App screens fully curated by Gutenberg.

The BlocksRenderer component

The BlocksRenderer component is the heart of the “HTML to React” approach. It receives arbitrary HTML markup, runs its content through wpKsesPost, and replaces markup with react component based on the child components passed to it. This approach is not tied to Gutenberg markup in any way, it can be used as a generic HTML-to-React conversion tool. Here’s a simple example of how it works

const MyLinkBlock = ({ domNode, children }) => {
// get the html attributes from the dom node
const { href, rel } = domNode.attribs;

return (
<MyFrameWorkSpecificLinkComponent href={href} rel={rel}>
{children}
</MyFrameWorkSpecificLinkComponent>
);
};

export const Blocks = ({ html }) => {
return (
<BlocksRenderer html={html}>
<MyLinkBlock tagName="a" classList="my-special-anchor" />
</BlocksRenderer>
);
};

In the example above, we’re passing the HTML content directly to BlocksRenderer and we’re specifying that any anchor tags with a class of “my-special-anchor” should be replaced with MyLinkBlock.

The MyLinkBlock then gets one special prop called domNode which is the DOM Node that’s being replaced with a React component. You can use domNode to access attributes of the node such as href and rel in this case.

Alternatively, you can also specify a test function to match dom nodes, the example above could also have been written as shown below

<MyLinkBlock 
test={
(node) => node.type === 'tag'
&& node.name === 'a'
&& node.attribs.class === 'my-special-anchor'
}
/>

There are a number of utility functions that make matching nodes and blocks specifically very easy as we’ll see now.

Matching blocks with isBlock

The isBlock function matches a DOM node by its tagName and optionally CSS classes.

<BlocksRenderer html={html}>
<MyCustomBlock
test={(node) => isBlock(node, { tagName: 'div', classList: ['block-class-name'] })}
/>
</BlocksRenderer>

Matching Blocks with isBlockByName

The isBlockByName matches a DOM node by its Gutenberg block name. This function requires the HeadstartWP plugin. The plugin appends two special attributes to every block: data-wp-block-name and data-wp-block-attrs.

This is a very handy function as it makes it very easy to match any registered Gutenberg block.

<BlocksRenderer html={html}>
<MyCustomParagraphBlock
test={(node) => isBlock(node, 'core/paragraph')}
/>
</BlocksRenderer>

Core Blocks

Not all core blocks would need to be rendered as React components, but when needed to replace core blocks with react components, the framework provides a set of components that does the heavy lifting of matching core blocks and getting their properties. This set of blocks can be seen here.

You can explore how this works by using a debug block component to inspect all of its props.

import {
BlocksRenderer,
YoutubeLiteBlock,
ImageBlock,
ColumnBlock,
ColumnsBlock,
ParagraphBlock,
DebugBlock,
} from '@headstartwp/core/react';

<BlocksRenderer html={html}>
{ /* .... */ }
<ColumnBlock component={DebugBlock} />
<ColumnsBlock component={DebugBlock} />
<ParagraphBlock component={DebugBlock} />
</BlocksRenderer>

You should see something like this -Debug Blocks

By inspecting the props you can see you have access to things like block name, className, and even the Gutenberg attributes. You could, in theory, build your implementation for every block without loading any of the default Gutenberg styles, shipping your own component library/design system.

Finely crafted by 10up, ©2023.

- +Debug Blocks

By inspecting the props you can see you have access to things like block name, className, and even the Gutenberg attributes. You could, in theory, build your implementation for every block without loading any of the default Gutenberg styles, shipping your own component library/design system.

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/gutenberg/rendering-custom-blocks/index.html b/learn/gutenberg/rendering-custom-blocks/index.html index b1ab02155..0c76e5f8d 100644 --- a/learn/gutenberg/rendering-custom-blocks/index.html +++ b/learn/gutenberg/rendering-custom-blocks/index.html @@ -7,13 +7,13 @@ - +
-

Finely crafted by 10up, ©2023.

- +

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/index.html b/learn/index.html index 7854916d3..43191e539 100644 --- a/learn/index.html +++ b/learn/index.html @@ -7,13 +7,13 @@ - + - +

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/utilities/sanitization/index.html b/learn/utilities/sanitization/index.html index 852d10736..74cb6d17b 100644 --- a/learn/utilities/sanitization/index.html +++ b/learn/utilities/sanitization/index.html @@ -7,13 +7,13 @@ - +
-

Escaping & Sanitization

As you're probably aware, React won't render raw HTML by default. If you want to do so you must use dangerouslySetInnerHTML.

This page describes some of the utility functions and components provided by the framework to help with escaping & sanitization when rendering raw markup.

wpKsesPost

This function sanitizes HTML content with requirements similar to wp_kses_post. If you are rendering arbitrary HTML markup you should probably run the markup through this function first.

import { wpKsesPost } from '@headstartwp/core';

const markup = { __html: wpKsesPost('<p>some raw html</p>') };
return <div dangerouslySetInnerHTML={markup} />;

stripTags

This function simply strips any html tags from a string. This can be useful in contexts where you don't want any HTML to be rendered.

import { stripTags } from '@headstartwp/core';

return <h1>{stripTags('this is a title <span>without a span</span>')}</h1>;

BlocksRenderer

When using BlocksRenderer your markup already goes through wpKsesPost so there's nothing else you need to worry about.

HtmlDecoder

Sometimes you might just want to decode some HTML entities without actually rendering any HTML tags. For this purpose you can use the HtmlDecoder component.

import { HtmlDecoder } from '@headstartwp/core/react';

<h1>
<HtmlDecoder html="Hello world! &#8211; foo bar &#8211;"/>
</h1>

SafeHtml

The SafeHtml component provides an easy way to safely render HTML markup. It runs the markup through wpKsesPost just like BlocksRenderer.

import { SafeHtml } from '@headstartwp/core/react';

<SafeHtml html="<div><p>hello world</p> div content</div>">

decodeHtmlSpeciaChars

This function will decode a pre-defined set of html special chars.

import { decodeHtmlSpeciaChars } from '@headstartwp/core';

decodeHtmlSpeciaChars('Hello world! &#8211; foo bar &#8211');

Finely crafted by 10up, ©2023.

- +

Escaping & Sanitization

As you're probably aware, React won't render raw HTML by default. If you want to do so you must use dangerouslySetInnerHTML.

This page describes some of the utility functions and components provided by the framework to help with escaping & sanitization when rendering raw markup.

wpKsesPost

This function sanitizes HTML content with requirements similar to wp_kses_post. If you are rendering arbitrary HTML markup you should probably run the markup through this function first.

import { wpKsesPost } from '@headstartwp/core';

const markup = { __html: wpKsesPost('<p>some raw html</p>') };
return <div dangerouslySetInnerHTML={markup} />;

stripTags

This function simply strips any html tags from a string. This can be useful in contexts where you don't want any HTML to be rendered.

import { stripTags } from '@headstartwp/core';

return <h1>{stripTags('this is a title <span>without a span</span>')}</h1>;

BlocksRenderer

When using BlocksRenderer your markup already goes through wpKsesPost so there's nothing else you need to worry about.

HtmlDecoder

Sometimes you might just want to decode some HTML entities without actually rendering any HTML tags. For this purpose you can use the HtmlDecoder component.

import { HtmlDecoder } from '@headstartwp/core/react';

<h1>
<HtmlDecoder html="Hello world! &#8211; foo bar &#8211;"/>
</h1>

SafeHtml

The SafeHtml component provides an easy way to safely render HTML markup. It runs the markup through wpKsesPost just like BlocksRenderer.

import { SafeHtml } from '@headstartwp/core/react';

<SafeHtml html="<div><p>hello world</p> div content</div>">

decodeHtmlSpeciaChars

This function will decode a pre-defined set of html special chars.

import { decodeHtmlSpeciaChars } from '@headstartwp/core';

decodeHtmlSpeciaChars('Hello world! &#8211; foo bar &#8211');

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/wordpress-integration/basic-auth/index.html b/learn/wordpress-integration/basic-auth/index.html index e0263db4c..42c33f92c 100644 --- a/learn/wordpress-integration/basic-auth/index.html +++ b/learn/wordpress-integration/basic-auth/index.html @@ -7,14 +7,14 @@ - +

Basic Auth

If WordPress is protected by Basic Auth (which is common during development) you can tell HeadstartWP the basic auth creds so that all -REST API requests include them. To do so, simply add the following env variables:

WP_BASIC_AUTH_USERNAME=username
WP_BASIC_AUTH_PASSWORD=password
caution

The above env variables will only be accessible server-side and therefore any client-side requests made directly to WordPress will fail. This happens because Next.js only includes env variables prefixed with NEXT_PUBLIC_ in the browser bundle.

If you want your client-side requests to work, prefix the above variables with NEXT_PUBLIC_. But note that the basic auth creds will be leaked to the public.

Finely crafted by 10up, ©2023.

- +REST API requests include them. To do so, simply add the following env variables:

WP_BASIC_AUTH_USERNAME=username
WP_BASIC_AUTH_PASSWORD=password
caution

The above env variables will only be accessible server-side and therefore any client-side requests made directly to WordPress will fail. This happens because Next.js only includes env variables prefixed with NEXT_PUBLIC_ in the browser bundle.

If you want your client-side requests to work, prefix the above variables with NEXT_PUBLIC_. But note that the basic auth creds will be leaked to the public.

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/wordpress-integration/feeds/index.html b/learn/wordpress-integration/feeds/index.html index bd7a520fc..c251b5c1b 100644 --- a/learn/wordpress-integration/feeds/index.html +++ b/learn/wordpress-integration/feeds/index.html @@ -7,13 +7,13 @@ - +
-

Feeds

Feeds are proxied via Next.js rewrites by default. meaning that you can directly access the feed via your front-end/Next.js URL.

If you have the plugin enabled, the URLs in the feed will also be rewritten to use front-end URLs. URLs are only rewritten if ?rewrite_urls=1 is passed to a feed URL (which the framework does automatically). The following is the default rewrite rule set by the framework in Next.js:

{
source: `${prefix}/feed`,
destination: `${wpUrl}/feed/?rewrite_urls=1`,
},

Therefore, accessing the feed from your WordPress domain will display the WP URLs unless you pass ?rewrite_urls=1.

Filtering when to rewrite URLs

If you want to better control when feed URLs are rewritten there's a filter called tenup_headless_wp_should_rewrite_feed_urls.

/**
* Filter's out whether feed urls should be rewritten
*
* @param boolean $rewrite_urls Whether the current request should rewrite_urls
*/
return apply_filters( 'tenup_headless_wp_should_rewrite_feed_urls', (bool) $rewrite_urls );

You could use this to always enable rewriting the feed URLs or to use a different query param to enable URL rewrites in the feed.

Finely crafted by 10up, ©2023.

- +

Feeds

Feeds are proxied via Next.js rewrites by default. meaning that you can directly access the feed via your front-end/Next.js URL.

If you have the plugin enabled, the URLs in the feed will also be rewritten to use front-end URLs. URLs are only rewritten if ?rewrite_urls=1 is passed to a feed URL (which the framework does automatically). The following is the default rewrite rule set by the framework in Next.js:

{
source: `${prefix}/feed`,
destination: `${wpUrl}/feed/?rewrite_urls=1`,
},

Therefore, accessing the feed from your WordPress domain will display the WP URLs unless you pass ?rewrite_urls=1.

Filtering when to rewrite URLs

If you want to better control when feed URLs are rewritten there's a filter called tenup_headless_wp_should_rewrite_feed_urls.

/**
* Filter's out whether feed urls should be rewritten
*
* @param boolean $rewrite_urls Whether the current request should rewrite_urls
*/
return apply_filters( 'tenup_headless_wp_should_rewrite_feed_urls', (bool) $rewrite_urls );

You could use this to always enable rewriting the feed URLs or to use a different query param to enable URL rewrites in the feed.

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/wordpress-integration/gutenberg/index.html b/learn/wordpress-integration/gutenberg/index.html index 545a27956..8ebd793ca 100644 --- a/learn/wordpress-integration/gutenberg/index.html +++ b/learn/wordpress-integration/gutenberg/index.html @@ -7,13 +7,13 @@ - +
-

Gutenberg

The HeadstartWP Plugin enhances every block with two special attributes directly in the markup: data-wp-block-name and data-wp-block. The first holds the name of the block and the second holds all of the block attributes.

These data attributes can be used for matching blocks in BlocksRenderer and for accessing block's attributes directly in your React component.

Available Filters

There are a few filters available that you can hook into.

tenup_headless_wp_render_block_attrs

This filter allows you to filter the block attributes before serializing them into the markup. You can use this to include additional attributes that you might need on the front-end. For instance, you can add information for a post instead of just a post id to prevent making an extra HTTP request to get the data for a post.

/**
* Filter's out the block's attributes before serializing in the block markup.
*
* @param array $attrs The Block's Attributes
* @param array $block The Block's schema
* @param \WP_Block $block_instance The block's instance
*/
$block_attrs = apply_filters(
'tenup_headless_wp_render_block_attrs',
$block_attrs,
$block,
$block_instance
);

tenup_headless_wp_render_blocks_attrs_serialized

This filter is not as useful as the previous one but it allows you to filter the serialized attributes.

/**
* Filter's out the block's attributes after serialization
*
* @param string $encoded_attrs The serialized block's Attributes
* @param array $attrs The Block's Attributes
* @param array $block The Block's schema
* @param \WP_Block $block_instance The block's instance
*/
$block_attrs_serialized = apply_filters(
'tenup_headless_wp_render_blocks_attrs_serialized',
esc_attr( wp_json_encode( $block_attrs ) ),
$block_attrs,
$block,
$block_instance
);

tenup_headless_wp_render_block_use_tag_processor

HeadstartWP will use the DomDocument API for parsing and enhancing the block markup by default. Since 1.0.7, it is possible to opt into the new WP_Html_Tag_Processor API via the tenup_headless_wp_render_block_use_tag_processor.

add_filter( 'tenup_headless_wp_render_block_use_tag_processor', '__return_true' );

In the next major release, usage of the DomDocument API will be removed in favor of WP_Html_Tag_Processor since it's easier to use and a core API. For most users this should not change anything, both APIs should yield the same result and the deprecation of the DomDocument API is merely for simplicity.

tenup_headless_wp_render_block_markup

This filter is called after adding the data attributes but before returning the block's final markup. You can use this filter to perform any additional modifications to the block markup.

This filter is only called when using the DomDocument API (i.e - the filter tenup_headless_wp_render_block_use_tag_processor returns false).

/**
* Filter the block's DOMElement before rendering
*
* @param \DOMElement $root_node
* @param string $html The original block markup
* @param array $block The Block's schema
* @param \WP_Block $block_instance The block's instance
*/
$root_node = apply_filters(
'tenup_headless_wp_render_block_markup',
$root_node,
$html,
$block,
$block_instance
);

tenup_headless_wp_render_html_tag_processor_block_markup

This filter is called after adding the data attributes but before returning the block's final markup when the WP_HTML_Tag_Processor API is being used. You can use this filter to perform any additional modifications to the block markup.

This filter is only called when using the WP_HTML_Tag_Processor API (i.e - the filter tenup_headless_wp_render_block_use_tag_processor returns true).

/**
* Filter the block's before rendering
*
* @param \WP_HTML_Tag_Processor $doc
* @param string $html The original block markup
* @param array $block The Block's schema
* @param \WP_Block $block_instance The block's instance
*/
$doc = apply_filters(
'tenup_headless_wp_render_html_tag_processor_block_markup',
$doc,
$html,
$block,
$block_instance
);

Finely crafted by 10up, ©2023.

- +

Gutenberg

The HeadstartWP Plugin enhances every block with two special attributes directly in the markup: data-wp-block-name and data-wp-block. The first holds the name of the block and the second holds all of the block attributes.

These data attributes can be used for matching blocks in BlocksRenderer and for accessing block's attributes directly in your React component.

Available Filters

There are a few filters available that you can hook into.

tenup_headless_wp_render_block_attrs

This filter allows you to filter the block attributes before serializing them into the markup. You can use this to include additional attributes that you might need on the front-end. For instance, you can add information for a post instead of just a post id to prevent making an extra HTTP request to get the data for a post.

/**
* Filter's out the block's attributes before serializing in the block markup.
*
* @param array $attrs The Block's Attributes
* @param array $block The Block's schema
* @param \WP_Block $block_instance The block's instance
*/
$block_attrs = apply_filters(
'tenup_headless_wp_render_block_attrs',
$block_attrs,
$block,
$block_instance
);

tenup_headless_wp_render_blocks_attrs_serialized

This filter is not as useful as the previous one but it allows you to filter the serialized attributes.

/**
* Filter's out the block's attributes after serialization
*
* @param string $encoded_attrs The serialized block's Attributes
* @param array $attrs The Block's Attributes
* @param array $block The Block's schema
* @param \WP_Block $block_instance The block's instance
*/
$block_attrs_serialized = apply_filters(
'tenup_headless_wp_render_blocks_attrs_serialized',
esc_attr( wp_json_encode( $block_attrs ) ),
$block_attrs,
$block,
$block_instance
);

tenup_headless_wp_render_block_use_tag_processor

HeadstartWP will use the DomDocument API for parsing and enhancing the block markup by default. Since 1.0.7, it is possible to opt into the new WP_Html_Tag_Processor API via the tenup_headless_wp_render_block_use_tag_processor.

add_filter( 'tenup_headless_wp_render_block_use_tag_processor', '__return_true' );

In the next major release, usage of the DomDocument API will be removed in favor of WP_Html_Tag_Processor since it's easier to use and a core API. For most users this should not change anything, both APIs should yield the same result and the deprecation of the DomDocument API is merely for simplicity.

tenup_headless_wp_render_block_markup

This filter is called after adding the data attributes but before returning the block's final markup. You can use this filter to perform any additional modifications to the block markup.

This filter is only called when using the DomDocument API (i.e - the filter tenup_headless_wp_render_block_use_tag_processor returns false).

/**
* Filter the block's DOMElement before rendering
*
* @param \DOMElement $root_node
* @param string $html The original block markup
* @param array $block The Block's schema
* @param \WP_Block $block_instance The block's instance
*/
$root_node = apply_filters(
'tenup_headless_wp_render_block_markup',
$root_node,
$html,
$block,
$block_instance
);

tenup_headless_wp_render_html_tag_processor_block_markup

This filter is called after adding the data attributes but before returning the block's final markup when the WP_HTML_Tag_Processor API is being used. You can use this filter to perform any additional modifications to the block markup.

This filter is only called when using the WP_HTML_Tag_Processor API (i.e - the filter tenup_headless_wp_render_block_use_tag_processor returns true).

/**
* Filter the block's before rendering
*
* @param \WP_HTML_Tag_Processor $doc
* @param string $html The original block markup
* @param array $block The Block's schema
* @param \WP_Block $block_instance The block's instance
*/
$doc = apply_filters(
'tenup_headless_wp_render_html_tag_processor_block_markup',
$doc,
$html,
$block,
$block_instance
);

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/wordpress-integration/multisite/index.html b/learn/wordpress-integration/multisite/index.html index 41e6ea0d9..6d46bd4d4 100644 --- a/learn/wordpress-integration/multisite/index.html +++ b/learn/wordpress-integration/multisite/index.html @@ -7,13 +7,13 @@ - +
-

Multisite

HeadstartWP has built-in support for WordPress multisite via the sites property in the headstartwp.config.js file. This transforms the Next.js app into a multi-tenant app.

The sites option allows specifying as many sites you want to connect to your app. Each site must have a sourceUrl and a hostUrl. The hostUrl will be used to match the current site and sourceUrl indicates where content should be sourced from.

This feature does not require that all sites belong to the same multisite, you're free to connect the Next.js app to a completely separate WordPress instance, as long as that instance implements what your Next.js app needs.

Take a look at the multisite demo project to familiarize yourself with the set-up.

Usage

Config

The first step is to declare all of your sites in headstartwp.config.js. In the example below we're declaring two sites.

/**
* Headless Config
*
* @type {import('@headstartwp/core').HeadlessConfig}
*/
module.exports = {
redirectStrategy: '404',
useWordPressPlugin: true,

sites: [
{
hostUrl: 'http://site1.localhost:3001',
sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,

},
{
hostUrl: 'http://site2.localhost:3001',
sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL_2,
},
],
};

In the example above we specify that all sites must use the WordPress plugin and that the redirect strategy should be 404. Then we're declaring two sites that will respond via the http://site1.localhost:3001 and http://site2.localhost:3001 URLs. The sourceUrl for each comes from an env variable.

This means that when we visit http://site1.localhost:3001, the source URL specified by NEXT_PUBLIC_HEADLESS_WP_URL will be used.

Internationalized routing

If you're using Next.js i18n feature you can specify the locale in the site's config object and the locale will also be used when matching a site.

/**
* Headless Config
*
* @type {import('@headstartwp/core').HeadlessConfig}
*/
module.exports = {
redirectStrategy: '404',
useWordPressPlugin: true,

sites: [
{
hostUrl: 'http://site1.localhost:3001',
sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,
locale: 'en'
},
{
hostUrl: 'http://site1.localhost:3001',
sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL_2,
locale: 'es'
},
],
};

The above config means that http://site1.localhost:3001/en will match the first site config and http://site1.localhost:3001/es will match the second site config.

Note: You must declare those locales in Next.js config. See Next.js documentation for more information.

When using locales make sure to add the locale to Settings -> General -> Headless Multisite Locale (optional). This is required for previews and the revalidate handler to work properly since API routes are not localized in Next.js.

As an example, the first site config in the example above would need the following settings in WordPress.

Plugin settings Multisite Locale

Middleware

Make sure you have the framework's middleware setup at src/middleware.js.

import { AppMiddleware } from '@headstartwp/next/middlewares';

export const config = {
matcher: [
/*
* Match all paths except for:
* 1. /api routes
* 2. /_next (Next.js internals)
* 3. /fonts (inside /public)
* 4. all root files inside /public (e.g. /favicon.ico)
*/
'/((?!api|_next|fonts[\\w-]+\\.\\w+).*)',
],
};

export async function middleware(...args) {
return AppMiddleware(...args);
}

Folder structure

Put all of your page routes in _sites/[site]/ folder with the exception of the following files

  • _app.js
  • _document.js
  • 404.js
  • 500.js
  • api/

This should give you a structure similar to

_sites/
├─ [site]/
│ ├─ [...path].js
│ ├─ index.js
_app.js
_document.js
404.js
500.js
api/

With this setup, the framework's middleware will rewrite all requests to _sites/hostName. All of the data-fetching hooks will fetch data to the appropriate WordPress instance.

This allows you to power all of your sites with the same codebase. This is very useful if you're building sites that support internationalization or if the only thing that changes across sites is the content.

Creating Routes that target a specific site

It is possible to create routes specific to each site. To do this simply create a folder for that particular site eg: src/pages/_sites/mysite.com/index.js. Then when a user visits mysite.com the index.js route file will be used instead of the one in [site]/index.js.

This provides a powerful way of powering complex multi-tenant apps that shares a codebase but render completely different pages and layouts.

Known Issues

404.js and 500.js are unable to know the current site

At the moment, there's a limitation in Next.js that doesn't allow the 404.js and 500.js pages to know the current site. These two files must be in the root of the pages directory and we can't rewrite them. Additionally, they only support getStaticProps which means there's no way to know which site you're on in case you need to fetch data specific for that site.

If you need to fetch data in 404.js or 500.js there's one workaround but it relies on client-side data-fetching. In _app.js do the following:

import { getSiteByHost } from '@headstartwp/core';

//grab the current site
const currentSite = useMemo(() => {
if (router.query?.site && !Array.isArray(router.query.site)) {
return getSiteByHost(router.query.site, router.locale);
}

// 404.js and 500.js do not have a site query param.
if (typeof window !== 'undefined') {
return getSiteByHost(window.location.host, router.locale);
}
return {};
}, [router]);

// pass it to HeadlessApp to override the current site settings defined by the framework
// once react hydrates and window is defined, the currentSite will be set for 404 and 500 poages.
<HeadlessApp settings={currentSite} />

Finely crafted by 10up, ©2023.

- +

Multisite

HeadstartWP has built-in support for WordPress multisite via the sites property in the headstartwp.config.js file. This transforms the Next.js app into a multi-tenant app.

The sites option allows specifying as many sites you want to connect to your app. Each site must have a sourceUrl and a hostUrl. The hostUrl will be used to match the current site and sourceUrl indicates where content should be sourced from.

This feature does not require that all sites belong to the same multisite, you're free to connect the Next.js app to a completely separate WordPress instance, as long as that instance implements what your Next.js app needs.

Take a look at the multisite demo project to familiarize yourself with the set-up.

Usage

Config

The first step is to declare all of your sites in headstartwp.config.js. In the example below we're declaring two sites.

/**
* Headless Config
*
* @type {import('@headstartwp/core').HeadlessConfig}
*/
module.exports = {
redirectStrategy: '404',
useWordPressPlugin: true,

sites: [
{
hostUrl: 'http://site1.localhost:3001',
sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,

},
{
hostUrl: 'http://site2.localhost:3001',
sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL_2,
},
],
};

In the example above we specify that all sites must use the WordPress plugin and that the redirect strategy should be 404. Then we're declaring two sites that will respond via the http://site1.localhost:3001 and http://site2.localhost:3001 URLs. The sourceUrl for each comes from an env variable.

This means that when we visit http://site1.localhost:3001, the source URL specified by NEXT_PUBLIC_HEADLESS_WP_URL will be used.

Internationalized routing

If you're using Next.js i18n feature you can specify the locale in the site's config object and the locale will also be used when matching a site.

/**
* Headless Config
*
* @type {import('@headstartwp/core').HeadlessConfig}
*/
module.exports = {
redirectStrategy: '404',
useWordPressPlugin: true,

sites: [
{
hostUrl: 'http://site1.localhost:3001',
sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,
locale: 'en'
},
{
hostUrl: 'http://site1.localhost:3001',
sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL_2,
locale: 'es'
},
],
};

The above config means that http://site1.localhost:3001/en will match the first site config and http://site1.localhost:3001/es will match the second site config.

Note: You must declare those locales in Next.js config. See Next.js documentation for more information.

When using locales make sure to add the locale to Settings -> General -> Headless Multisite Locale (optional). This is required for previews and the revalidate handler to work properly since API routes are not localized in Next.js.

As an example, the first site config in the example above would need the following settings in WordPress.

Plugin settings Multisite Locale

Middleware

Make sure you have the framework's middleware setup at src/middleware.js.

import { AppMiddleware } from '@headstartwp/next/middlewares';

export const config = {
matcher: [
/*
* Match all paths except for:
* 1. /api routes
* 2. /_next (Next.js internals)
* 3. /fonts (inside /public)
* 4. all root files inside /public (e.g. /favicon.ico)
*/
'/((?!api|_next|fonts[\\w-]+\\.\\w+).*)',
],
};

export async function middleware(...args) {
return AppMiddleware(...args);
}

Folder structure

Put all of your page routes in _sites/[site]/ folder with the exception of the following files

  • _app.js
  • _document.js
  • 404.js
  • 500.js
  • api/

This should give you a structure similar to

_sites/
├─ [site]/
│ ├─ [...path].js
│ ├─ index.js
_app.js
_document.js
404.js
500.js
api/

With this setup, the framework's middleware will rewrite all requests to _sites/hostName. All of the data-fetching hooks will fetch data to the appropriate WordPress instance.

This allows you to power all of your sites with the same codebase. This is very useful if you're building sites that support internationalization or if the only thing that changes across sites is the content.

Creating Routes that target a specific site

It is possible to create routes specific to each site. To do this simply create a folder for that particular site eg: src/pages/_sites/mysite.com/index.js. Then when a user visits mysite.com the index.js route file will be used instead of the one in [site]/index.js.

This provides a powerful way of powering complex multi-tenant apps that shares a codebase but render completely different pages and layouts.

Known Issues

404.js and 500.js are unable to know the current site

At the moment, there's a limitation in Next.js that doesn't allow the 404.js and 500.js pages to know the current site. These two files must be in the root of the pages directory and we can't rewrite them. Additionally, they only support getStaticProps which means there's no way to know which site you're on in case you need to fetch data specific for that site.

If you need to fetch data in 404.js or 500.js there's one workaround but it relies on client-side data-fetching. In _app.js do the following:

import { getSiteByHost } from '@headstartwp/core';

//grab the current site
const currentSite = useMemo(() => {
if (router.query?.site && !Array.isArray(router.query.site)) {
return getSiteByHost(router.query.site, router.locale);
}

// 404.js and 500.js do not have a site query param.
if (typeof window !== 'undefined') {
return getSiteByHost(window.location.host, router.locale);
}
return {};
}, [router]);

// pass it to HeadlessApp to override the current site settings defined by the framework
// once react hydrates and window is defined, the currentSite will be set for 404 and 500 poages.
<HeadlessApp settings={currentSite} />

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/wordpress-integration/polylang/index.html b/learn/wordpress-integration/polylang/index.html index fbb82a76f..b8c5db4d8 100644 --- a/learn/wordpress-integration/polylang/index.html +++ b/learn/wordpress-integration/polylang/index.html @@ -7,13 +7,13 @@ - +
-

Polylang Integration

caution

Polylang Pro is required since only Polylang Pro offers the REST API integration.

It is possible to integrate with Polylang by enabling the integration in headstartwp.config.js and adding the supported locales to Next.js config.

headstartwp.config.js
module.exports = {
// other settings
integrations: {
yoastSEO: {
enable: true,
},
polylang: {
enable: true
},
},
};
next.config.js
module.exports = {
i18n: {
// These are all the locales you want to support in
// your application
locales: ['en', 'fr', 'nl'],
// This is the default locale you want to be used when visiting
// a non-locale prefixed path e.g. `/hello`
defaultLocale: 'en',
}
};
info

You need to make sure that the locales set in Polylang matches the locales set in Next.js config.

Enabling this integration will automatically add the lang attribute to all REST API calls made to WordPres (when using the data-fetching layer provided by the framework). The lang attribute will be set based on the current Next.js locale (context.locale or context.defaultLocale).

Finely crafted by 10up, ©2023.

- +

Polylang Integration

caution

Polylang Pro is required since only Polylang Pro offers the REST API integration.

It is possible to integrate with Polylang by enabling the integration in headstartwp.config.js and adding the supported locales to Next.js config.

headstartwp.config.js
module.exports = {
// other settings
integrations: {
yoastSEO: {
enable: true,
},
polylang: {
enable: true
},
},
};
next.config.js
module.exports = {
i18n: {
// These are all the locales you want to support in
// your application
locales: ['en', 'fr', 'nl'],
// This is the default locale you want to be used when visiting
// a non-locale prefixed path e.g. `/hello`
defaultLocale: 'en',
}
};
info

You need to make sure that the locales set in Polylang matches the locales set in Next.js config.

Enabling this integration will automatically add the lang attribute to all REST API calls made to WordPres (when using the data-fetching layer provided by the framework). The lang attribute will be set based on the current Next.js locale (context.locale or context.defaultLocale).

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/wordpress-integration/previews/index.html b/learn/wordpress-integration/previews/index.html index 48713c4f0..7fe40bb84 100644 --- a/learn/wordpress-integration/previews/index.html +++ b/learn/wordpress-integration/previews/index.html @@ -7,14 +7,14 @@ - +

Previews

The preview feature requires the 10up's headless WordPress plugin installed. The preview functionality is built on top of Next.js preview API. It uses a short-lived JWT token generated on the WordPress side that can only be used for previewing, this means it is not necessary to set up a hardcoded secret between WP and Next.js.

For previews to work, make sure the frontend URL is entered in WP settings as per instructions in Installing WordPress Plugin.

The logic for generating the JWT token and redirecting to the preview endpoint can be seen here.

$token = PreviewToken::generate(
[
'type' => 'preview',
'post_type' => $post_type,
'post_id' => $post_id,
]
);

$preview_url = sprintf(
'%sapi/preview?post_id=%d&post_type=%s&is_revision=%s&token=%s',
trailingslashit( Plugin::get_react_url() ),
$post_id,
$post_type,
$is_revision ? '1' : '0',
$token
);

wp_redirect( $preview_url );
die();

Below is a summary of the preview workflow.

  • First a token of type preview is generated
  • The token encodes the post type and post id.
  • A preview URL is generated assuming the preview endpoint lives at /api/preview
  • WordPress redirects to the preview endpoint
  • The token is sent alongside the post_type, post_id and a boolean indicating whether the post being previewed is a revision or not.
  • The token is verified against the parameters and the token is used to fetch the post's draft/revision content.

Usage

The Next.js project must expose a api/preview endpoint that uses the previewHandler.

//src/pages/api/preview.js
import { previewHandler } from '@headstartwp/next';

/**
* The Preview endpoint just needs to proxy the default preview handler
*
* @param {*} req Next.js request object
* @param {*} res Next.js response object
*
* @returns
*/
export default async function handler(req, res) {
return previewHandler(req, res);
}

That's all that is needed to enable WordPress preview.

While previewing the URL will not reflect the actual URL of the post, but instead, it will contain the post id and a -preview suffix.

previewHandler options

preparePreviewData

This allows you to alter the preview data object before it is stored by Next.js (i.e before calling res.setPreviewData). You can use this if you need to add additional fields to preview data object.

export default async function handler(req, res) {
return previewHandler(req, res, {
preparePreviewData(req, res, post, previewData) {
return { ...previewData, name: post.name };
},
});
}

name would now be available in the context object of getServerSideProps and getStaticProps (ctx.previewData);

getRedirectPath

info

This option was added in @headstartwp/next@1.1.0.

The getRedirectPath option allows you to customize the redirected URL that should handle the preview request. This can be useful if you have implemented a non-standard URL structure. For instance, if the permalink for your posts are /%category%/%postname%/ you could create a /src/pages/[category]/[...path.js] route to handle single post. However, once you do that the previewHandler doesn't know how to redirect to that URL and as such you will have to provide your own redirect handling.

The framework will also use this value to restrict the preview cookie to the post being previewed to avoid bypassing getStaticProps until the cookie expires or the browser is closed. See the Next.js docs for more info.

import { getPostTerms } from '@headstartwp/core';
import { previewHandler } from '@headstartwp/next';

export default async function handler(req, res) {
return previewHandler(req, res, {
getRedirectPath(defaultRedirectPath, post) {
const { type, id, slug } = post;

if (type === 'post') {
const terms = getPostTerms(post);

if (Array.isArray(terms?.category) && terms.category.length > 0) {
const [category] = terms.category;

return `/${categorySlug}/${id}/${slug || id}`;
}
}

return defaultRedirectPath
},
});
}

onRedirect

caution

Instead of implementing onRedirect we recommend implementing getRedirectPath instead as that will only enable the preview cookie for -the post being previewed.

The onRedirect gives you full access to the req and res objects. If you do need implement this function we recommend also implementing getRedirectPath.

caution

When handling redirects yourself, make sure to always append -preview=true to the end of the redirected URL.

import { getPostTerms } from '@headstartwp/core';
import { previewHandler } from '@headstartwp/next';

export default async function handler(req, res) {
return previewHandler(req, res, {
onRedirect(req, res, previewData) {
return res.redirect('/custom-path-preview-true');
},
});
}

FAQ

After a while, the preview URL stops working

The JWT token expires after 5 min by default, after this period, open another preview window from WordPress to preview the post. The Next.js preview cookie also last for only 5 minutes.

I'm unable to preview a custom post type

Make sure you defined the right single property when registering the custom post type. See headless config docs. The single property must match the route prefix for the custom post type.

Finely crafted by 10up, ©2023.

- +the post being previewed.

The onRedirect gives you full access to the req and res objects. If you do need implement this function we recommend also implementing getRedirectPath.

caution

When handling redirects yourself, make sure to always append -preview=true to the end of the redirected URL.

import { getPostTerms } from '@headstartwp/core';
import { previewHandler } from '@headstartwp/next';

export default async function handler(req, res) {
return previewHandler(req, res, {
onRedirect(req, res, previewData) {
return res.redirect('/custom-path-preview-true');
},
});
}

FAQ

After a while, the preview URL stops working

The JWT token expires after 5 min by default, after this period, open another preview window from WordPress to preview the post. The Next.js preview cookie also last for only 5 minutes.

I'm unable to preview a custom post type

Make sure you defined the right single property when registering the custom post type. See headless config docs. The single property must match the route prefix for the custom post type.

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/learn/wordpress-integration/revalidate/index.html b/learn/wordpress-integration/revalidate/index.html index b5ec47e0e..df6f83384 100644 --- a/learn/wordpress-integration/revalidate/index.html +++ b/learn/wordpress-integration/revalidate/index.html @@ -7,14 +7,14 @@ - +

On-demand ISR revalidation

On-demand Revalidation is the ability to revalidate static pages programmatically from the CMS.

Without On-demand ISR revalidation users will need to wait until the time set in the revalidate prop has passed before they can see an updated version of that page. This means that if a revalidate is set to 5min, users would potentially have to wait up to 5min before they can see new content.

It is preferred to have the CMS ask the Next.js app to revalidate those pages when possible. This can be done via "On-Demand Revalidation".

HeadstartWP supports Next.js ISR via the WordPress plugin and via @10up/next-redis-cache-provider for hosts that do not natively support Next.js ISR (e.g. VIP, WPEngine etc).

Usage

Plugin setup

HeadstartWP supports On-Demand Revalidation and it requires installing the WordPress Plugin. On-Demand Revalidation is opt-in and must be manually enabled in the plugin's settings (Settings -> General). -Plugin settings

The plugin expects the revalidate endpoint to live at /api/revalidate. It is possible to customize this endpoint via the tenup_headless_isr_revalidate_endpoint.

/**
* Filters the revalidate endpoint.
*
* @param string $revalidate_endpoint The revalidate endpoint
*/
$revalidate_endpoint = apply_filters(
'tenup_headless_isr_revalidate_endpoint',
trailingslashit( Plugin::get_react_url() ) . 'api/revalidate'
);

Revalidate Endpoint

Simply create a Next.js API endpoint that uses the revalidateHandler provided by the framework.

caution

If you changed the default value of the endpoint path via the tenup_headless_isr_revalidate_endpoint filter, make sure you change it in the Next.js app as well.

src/pages/api/revalidate
import { revalidateHandler } from '@headstartwp/next';

/**
* The revalidate endpoint just needs to proxy the default revalidate handler
*
* @param {*} req Next.js request object
* @param {*} res Next.js response object
*
* @returns
*/
export default async function handler(req, res) {
return revalidateHandler(req, res);
}

How does it work?

The default implementation will revalidate any post or page upon saving in WordPress. You can see the logic here.

Supporting Next.js ISR outside of Vercel

If your host does not support Next.js ISR natively (e.g. WordPress VIP, WPEngine etc), ISR won't work well. If your hosting is serving your app via a traditional non-serverless setup using docker/kubernetes you most likely will run into issues trying to leverage Next.js ISR.

First off, if multiple containers are running to serve the requests to your website, a call to revalidate a particular page will only ever hit one of the containers that are running. This will lead to users being served by the containers that weren't hit by the WP call to still serve the old page. Even worse, the same user might be served by different containers and get both old and new responses for a page (e.g. the initial HTML is updated but the JSON associated with the page isn't).

Officially, Next.js recommends sharing a writable volume across all the containers but that has some performance implications and some hosts simply don't support this setup.

@10up/next-redis-cache-provider

caution

If you are hosting on Vercel you do not need this package.

Our solution to this problem has been to replace the filesystem cache with a redis cache provider. So whenever Next.js revalidates a page instead of storing the static page in disk, it will write to a shared redis instance that all of the containers would be talking to. The diagram below exemplifies how it works.

Plugin settings

To set up @10up/next-redis-cache-provider first install it via npm:

npm install --save @10up/next-redis-cache-provider

Then add it in next.config.js:

next.config.js
const { withHeadstartWPConfig } = require('@headstartwp/next/config');

/**
* Update whatever you need within the nextConfig object.
*
* @type {import('next').NextConfig}
*/
const nextConfig = {
eslint: {
ignoreDuringBuilds: true,
},
};


if (process.env.NEXT_REDIS_URL || process.env.VIP_REDIS_PRIMARY) {
// eslint-disable-next-line global-require
const { initRedisClient } = require('@10up/next-redis-cache-provider');
initRedisClient();
nextConfig.experimental = {
incrementalCacheHandlerPath: require.resolve('@10up/next-redis-cache-provider'),
};
}

module.exports = withHeadstartWPConfig(nextConfig);
info

The HeadstartWP scaffold already includes the code above

The code above checks for NEXT_REDIS_URL and VIP_REDIS_PRIMARY (which is specific for WordPress VIP hosting), however there are several other env variables you can use to configure your redis connection.

  • NEXT_REDIS_URL: It's the simplest way to set up your redis connection, simply pass the full redis connection string.
  • VIP_REDIS_PRIMARY and VIP_REDIS_PASSWORD: this is specific to WordPress VIP hosting, if Redis is enabled on VIP hosting these env variables will be automatically set for you so you do not need to add them yourself.
  • NEXT_REDIS_HOST, NEXT_REDIS_PORT and NEXT_REDIS_PASS: Instead of a full redis connection string you can specify the host, port and password separately.
  • NEXT_REDIS_SENTINEL_NAME, NEXT_REDIS_SENTINEL_PASSWORD, NEXT_REDIS_PASS: This is only needed if you want to connect to a redis sentinel cluster. If you do so, you also need to set the NEXT_REDIS_HOST, NEXT_REDIS_PORT and NEXT_REDIS_PASS variables.

Purging the CDN Cache

Another thing you want to consider is flushing the CDN cache after you revalidate the page in Next.js. This can be done on the WordPress side by hooking up to the tenup_headless_wp_revalidate action. This action is fired off after Next.js has finished revalidating the page.

add_filter( 'tenup_headless_wp_revalidate', function( $post, $front_end_post_url ) {
// $front_end_psot_url is the URL for the post with the front-end/headless url.
function_to_clear_my_favorite_cdn_cache( $front_end_post_url );
}, 10, 2 );

A note about WordPress VIP

If you are hosting on WordPress VIP the plugin already clears the VIP CDN cache, so you don't need to handle this yourself. The following code is included in the plugin:

if ( 200 === (int) $status_code && function_exists( 'wpcom_vip_purge_edge_cache_for_url' ) ) {
wpcom_vip_purge_edge_cache_for_url( $headless_post_url );
}

Revalidating in a Cron Job

If you prefer to run the revalidation logic in the background, you can tell the plugin to schedule a one-off cron job for immediate execution every time a post is saved. This can be enabled with the tenup_headless_wp_revalidate_on_cron filter (it defaults to false).

add_filter( 'tenup_headless_wp_revalidate_on_cron', '___return_true' );

This can be useful when the revalidation or the CDN cache purge is slow sp this can be used to speed up the post saving process.

Finely crafted by 10up, ©2023.

- +Plugin settings

The plugin expects the revalidate endpoint to live at /api/revalidate. It is possible to customize this endpoint via the tenup_headless_isr_revalidate_endpoint.

/**
* Filters the revalidate endpoint.
*
* @param string $revalidate_endpoint The revalidate endpoint
*/
$revalidate_endpoint = apply_filters(
'tenup_headless_isr_revalidate_endpoint',
trailingslashit( Plugin::get_react_url() ) . 'api/revalidate'
);

Revalidate Endpoint

Simply create a Next.js API endpoint that uses the revalidateHandler provided by the framework.

caution

If you changed the default value of the endpoint path via the tenup_headless_isr_revalidate_endpoint filter, make sure you change it in the Next.js app as well.

src/pages/api/revalidate
import { revalidateHandler } from '@headstartwp/next';

/**
* The revalidate endpoint just needs to proxy the default revalidate handler
*
* @param {*} req Next.js request object
* @param {*} res Next.js response object
*
* @returns
*/
export default async function handler(req, res) {
return revalidateHandler(req, res);
}

How does it work?

The default implementation will revalidate any post or page upon saving in WordPress. You can see the logic here.

Supporting Next.js ISR outside of Vercel

If your host does not support Next.js ISR natively (e.g. WordPress VIP, WPEngine etc), ISR won't work well. If your hosting is serving your app via a traditional non-serverless setup using docker/kubernetes you most likely will run into issues trying to leverage Next.js ISR.

First off, if multiple containers are running to serve the requests to your website, a call to revalidate a particular page will only ever hit one of the containers that are running. This will lead to users being served by the containers that weren't hit by the WP call to still serve the old page. Even worse, the same user might be served by different containers and get both old and new responses for a page (e.g. the initial HTML is updated but the JSON associated with the page isn't).

Officially, Next.js recommends sharing a writable volume across all the containers but that has some performance implications and some hosts simply don't support this setup.

@10up/next-redis-cache-provider

caution

If you are hosting on Vercel you do not need this package.

Our solution to this problem has been to replace the filesystem cache with a redis cache provider. So whenever Next.js revalidates a page instead of storing the static page in disk, it will write to a shared redis instance that all of the containers would be talking to. The diagram below exemplifies how it works.

Plugin settings

To set up @10up/next-redis-cache-provider first install it via npm:

npm install --save @10up/next-redis-cache-provider

Then add it in next.config.js:

next.config.js
const { withHeadstartWPConfig } = require('@headstartwp/next/config');

/**
* Update whatever you need within the nextConfig object.
*
* @type {import('next').NextConfig}
*/
const nextConfig = {
eslint: {
ignoreDuringBuilds: true,
},
};


if (process.env.NEXT_REDIS_URL || process.env.VIP_REDIS_PRIMARY) {
// eslint-disable-next-line global-require
const { initRedisClient } = require('@10up/next-redis-cache-provider');
initRedisClient();
nextConfig.experimental = {
incrementalCacheHandlerPath: require.resolve('@10up/next-redis-cache-provider'),
};
}

module.exports = withHeadstartWPConfig(nextConfig);
info

The HeadstartWP scaffold already includes the code above

The code above checks for NEXT_REDIS_URL and VIP_REDIS_PRIMARY (which is specific for WordPress VIP hosting), however there are several other env variables you can use to configure your redis connection.

  • NEXT_REDIS_URL: It's the simplest way to set up your redis connection, simply pass the full redis connection string.
  • VIP_REDIS_PRIMARY and VIP_REDIS_PASSWORD: this is specific to WordPress VIP hosting, if Redis is enabled on VIP hosting these env variables will be automatically set for you so you do not need to add them yourself.
  • NEXT_REDIS_HOST, NEXT_REDIS_PORT and NEXT_REDIS_PASS: Instead of a full redis connection string you can specify the host, port and password separately.
  • NEXT_REDIS_SENTINEL_NAME, NEXT_REDIS_SENTINEL_PASSWORD, NEXT_REDIS_PASS: This is only needed if you want to connect to a redis sentinel cluster. If you do so, you also need to set the NEXT_REDIS_HOST, NEXT_REDIS_PORT and NEXT_REDIS_PASS variables.

Purging the CDN Cache

Another thing you want to consider is flushing the CDN cache after you revalidate the page in Next.js. This can be done on the WordPress side by hooking up to the tenup_headless_wp_revalidate action. This action is fired off after Next.js has finished revalidating the page.

add_filter( 'tenup_headless_wp_revalidate', function( $post, $front_end_post_url ) {
// $front_end_psot_url is the URL for the post with the front-end/headless url.
function_to_clear_my_favorite_cdn_cache( $front_end_post_url );
}, 10, 2 );

A note about WordPress VIP

If you are hosting on WordPress VIP the plugin already clears the VIP CDN cache, so you don't need to handle this yourself. The following code is included in the plugin:

if ( 200 === (int) $status_code && function_exists( 'wpcom_vip_purge_edge_cache_for_url' ) ) {
wpcom_vip_purge_edge_cache_for_url( $headless_post_url );
}

Revalidating in a Cron Job

If you prefer to run the revalidation logic in the background, you can tell the plugin to schedule a one-off cron job for immediate execution every time a post is saved. This can be enabled with the tenup_headless_wp_revalidate_on_cron filter (it defaults to false).

add_filter( 'tenup_headless_wp_revalidate_on_cron', '___return_true' );

This can be useful when the revalidation or the CDN cache purge is slow sp this can be used to speed up the post saving process.

Finely crafted by 10up, ©2023.

+ \ No newline at end of file diff --git a/philosophy/index.html b/philosophy/index.html index a8b2949db..a4ab1ae1d 100644 --- a/philosophy/index.html +++ b/philosophy/index.html @@ -7,13 +7,13 @@ - +

Framework Principles

These are the guiding principles for 10up's Headless Framework.

Solid Foundation

We aren't trying to reinvent the wheel nor do we want to spend a massive amount of resources building a new foundation for our framework. Therefore we decided to pick an existing and solid foundation to power 10up's Headless Framework: Next.js.

Next.js is by far the most used Full-Stack React Framework and we believe using Next.js will give us a solid foundation for our framework and let us focus on what matters: solving headless WordPress sites.

Reduce the complexity of building headless sites

The 10up headless framework aims at making creating headless sites as easy as creating traditional WordPress sites. We want to reduce the complexity that developers need to face when building headless WordPress sites from scratch.

We aim to let engineers focus on the important aspects of the site instead of spending time figuring out how to "wire up" the Next.js application with WordPress.

Explore new possibilities

We want to boost creativity and let engineers explore new ways of building and scaling sites. From shipping component libraries for brand consistency and code reuse to building complex app-like experiences. From leveraging the power of serverless to hosting completely at the Edge. These are all things that can be explored when going headless.

Low cost of maintenance

The 10up headless framework is a thin layer built on top of a solid foundation. It focuses on interacting with WordPress. At the end of the day, it's a Next.js application.

This means the maintenance cost is low as the lowest-level and most complex parts are provided by Next.js which is maintained by Vercel and have been driving a lot of innovations alongside partners like Google.

Simple stack

We also aim at maintaining a simple stack.

REST API over WPGraphQL

The 10up's Headless Framework at the moment does not work with WPGraphQL.

GraphQL is great and when used on the right project adds tons of value in the long run. However, for most headless sites, there isn’t much value added by GraphQL. The additional complexity and engineering time required by adopting GraphQL/WPGraphQL isn’t worth the cost most of the time (caching, persisted queries, cache-bursting, etc).

Building a proper GraphQL implementation that leverages all of the GraphQL advantages isn’t that easy. Proper implementation of GraphQL would mean doing something similar to what relay does and if you are not doing then you’re probably doing it wrong and losing most of its benefits.

We might add support for GraphQL in future releases but experience has shown us that GraphQL would be more suitable when building a middleware layer that's sitting in front of WordPress and that middleware is aggregating multiple sources of data, that use case however, is well beyond the scope of this framework.

Finely crafted by 10up, ©2023.

- + \ No newline at end of file diff --git a/search-index.json b/search-index.json index cdd58f848..77e181ba5 100644 --- a/search-index.json +++ b/search-index.json @@ -1 +1 @@ -[{"documents":[{"i":1,"t":"HeadstartWP","u":"/docs/api/","b":["API Reference"]},{"i":4,"t":"Class: ConfigError","u":"/docs/api/classes/headstartwp_core.ConfigError/","b":["API Reference","Classes"]},{"i":27,"t":"Class: AppSettingsStrategy","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","b":["API Reference","Classes"]},{"i":78,"t":"Class: Element","u":"/docs/api/classes/headstartwp_core.Element/","b":["API Reference","Classes"]},{"i":134,"t":"Class: EndpointError","u":"/docs/api/classes/headstartwp_core.EndpointError/","b":["API Reference","Classes"]},{"i":157,"t":"Class: Comment","u":"/docs/api/classes/headstartwp_core.Comment/","b":["API Reference","Classes"]},{"i":195,"t":"Class: FrameworkError","u":"/docs/api/classes/headstartwp_core.FrameworkError/","b":["API Reference","Classes"]},{"i":218,"t":"Class: AuthorArchiveFetchStrategy","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","b":["API Reference","Classes"]},{"i":273,"t":"Class: NotFoundError","u":"/docs/api/classes/headstartwp_core.NotFoundError/","b":["API Reference","Classes"]},{"i":296,"t":"Class: FetchError","u":"/docs/api/classes/headstartwp_core.FetchError/","b":["API Reference","Classes"]},{"i":319,"t":"Class: ProcessingInstruction","u":"/docs/api/classes/headstartwp_core.ProcessingInstruction/","b":["API Reference","Classes"]},{"i":365,"t":"Class: PostsArchiveFetchStrategy","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","b":["API Reference","Classes"]},{"i":420,"t":"Class: PostOrPostsFetchStrategy","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","b":["API Reference","Classes"]},{"i":481,"t":"Class: SearchFetchStrategy","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","b":["API Reference","Classes"]},{"i":536,"t":"Class: Text","u":"/docs/api/classes/headstartwp_core.Text/","b":["API Reference","Classes"]},{"i":574,"t":"Class: SinglePostFetchStrategy","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","b":["API Reference","Classes"]},{"i":637,"t":"Class: TaxonomyTermsStrategy","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","b":["API Reference","Classes"]},{"i":690,"t":"Enumeration: LOGTYPE","u":"/docs/api/enums/headstartwp_core.LOGTYPE/","b":["API Reference","Enumerations"]},{"i":701,"t":"Interface: AuthorEntity","u":"/docs/api/interfaces/headstartwp_core.AuthorEntity/","b":["API Reference","Interfaces"]},{"i":726,"t":"Interface: AppEntity","u":"/docs/api/interfaces/headstartwp_core.AppEntity/","b":["API Reference","Interfaces"]},{"i":743,"t":"Interface: AvatarUrls","u":"/docs/api/interfaces/headstartwp_core.AvatarUrls/","b":["API Reference","Interfaces"]},{"i":754,"t":"Class: VerifyTokenFetchStrategy","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","b":["API Reference","Classes"]},{"i":803,"t":"Interface: CommentEntity","u":"/docs/api/interfaces/headstartwp_core.CommentEntity/","b":["API Reference","Interfaces"]},{"i":842,"t":"Interface: EndpointParams","u":"/docs/api/interfaces/headstartwp_core.EndpointParams/","b":["API Reference","Interfaces"]},{"i":855,"t":"Interface: AttachmentEntity","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","b":["API Reference","Interfaces"]},{"i":918,"t":"Interface: FetchOptions","u":"/docs/api/interfaces/headstartwp_core.FetchOptions/","b":["API Reference","Interfaces"]},{"i":927,"t":"Interface: FetchResponse","u":"/docs/api/interfaces/headstartwp_core.FetchResponse/","b":["API Reference","Interfaces"]},{"i":938,"t":"Interface: HTMLReactParserOptions","u":"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions/","b":["API Reference","Interfaces"]},{"i":949,"t":"Interface: Entity","u":"/docs/api/interfaces/headstartwp_core.Entity/","b":["API Reference","Interfaces"]},{"i":960,"t":"Interface: Integration","u":"/docs/api/interfaces/headstartwp_core.Integration/","b":["API Reference","Interfaces"]},{"i":967,"t":"Interface: FilterDataOptions","u":"/docs/api/interfaces/headstartwp_core.FilterDataOptions/","b":["API Reference","Interfaces"]},{"i":976,"t":"Interface: PageInfo","u":"/docs/api/interfaces/headstartwp_core.PageInfo/","b":["API Reference","Interfaces"]},{"i":985,"t":"Interface: PolylangIntegration","u":"/docs/api/interfaces/headstartwp_core.PolylangIntegration/","b":["API Reference","Interfaces"]},{"i":992,"t":"Interface: PageEntity","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","b":["API Reference","Interfaces"]},{"i":1047,"t":"Interface: MenuItemEntity","u":"/docs/api/interfaces/headstartwp_core.MenuItemEntity/","b":["API Reference","Interfaces"]},{"i":1086,"t":"Interface: PostEntity","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","b":["API Reference","Interfaces"]},{"i":1145,"t":"Interface: PostParams","u":"/docs/api/interfaces/headstartwp_core.PostParams/","b":["API Reference","Interfaces"]},{"i":1170,"t":"Interface: PostsArchiveParams","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","b":["API Reference","Interfaces"]},{"i":1233,"t":"Interface: PostOrPostsParams","u":"/docs/api/interfaces/headstartwp_core.PostOrPostsParams/","b":["API Reference","Interfaces"]},{"i":1252,"t":"Interface: AudioBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps/","b":["API Reference","Interfaces"]},{"i":1281,"t":"Interface: BlockAttributes","u":"/docs/api/interfaces/headstartwp_core.react.BlockAttributes/","b":["API Reference","Interfaces"]},{"i":1310,"t":"Interface: PostTypeEntity","u":"/docs/api/interfaces/headstartwp_core.PostTypeEntity/","b":["API Reference","Interfaces"]},{"i":1351,"t":"Interface: BlockProps","u":"/docs/api/interfaces/headstartwp_core.react.BlockProps/","b":["API Reference","Interfaces"]},{"i":1368,"t":"Class: AbstractFetchStrategy","u":"/docs/api/classes/headstartwp_core.AbstractFetchStrategy/","b":["API Reference","Classes"]},{"i":1419,"t":"Interface: BlockRendererProps","u":"/docs/api/interfaces/headstartwp_core.react.BlockRendererProps/","b":["API Reference","Interfaces"]},{"i":1430,"t":"Interface: Colors","u":"/docs/api/interfaces/headstartwp_core.react.Colors/","b":["API Reference","Interfaces"]},{"i":1451,"t":"Interface: ButtonBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps/","b":["API Reference","Interfaces"]},{"i":1482,"t":"Interface: ButtonsBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps/","b":["API Reference","Interfaces"]},{"i":1501,"t":"Interface: ColumnBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps/","b":["API Reference","Interfaces"]},{"i":1520,"t":"Interface: ColumnsBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps/","b":["API Reference","Interfaces"]},{"i":1539,"t":"Interface: CodeBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps/","b":["API Reference","Interfaces"]},{"i":1558,"t":"Interface: FetchHookOptions","u":"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions/","b":["API Reference","Interfaces"]},{"i":1569,"t":"Interface: CoverBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps/","b":["API Reference","Interfaces"]},{"i":1606,"t":"Interface: FileBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.FileBlockProps/","b":["API Reference","Interfaces"]},{"i":1631,"t":"Interface: GutenbergBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.GutenbergBlockProps/","b":["API Reference","Interfaces"]},{"i":1640,"t":"Interface: GroupBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps/","b":["API Reference","Interfaces"]},{"i":1663,"t":"Interface: HtmlDecodeProps","u":"/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps/","b":["API Reference","Interfaces"]},{"i":1668,"t":"Interface: HookResponse","u":"/docs/api/interfaces/headstartwp_core.react.HookResponse/","b":["API Reference","Interfaces"]},{"i":1681,"t":"Interface: HeadingBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps/","b":["API Reference","Interfaces"]},{"i":1702,"t":"Interface: IAudioBlock","u":"/docs/api/interfaces/headstartwp_core.react.IAudioBlock/","b":["API Reference","Interfaces"]},{"i":1723,"t":"Interface: IButtonBlock","u":"/docs/api/interfaces/headstartwp_core.react.IButtonBlock/","b":["API Reference","Interfaces"]},{"i":1744,"t":"Interface: IButtonsBlock","u":"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock/","b":["API Reference","Interfaces"]},{"i":1765,"t":"Interface: IBlock","u":"/docs/api/interfaces/headstartwp_core.react.IBlock/","b":["API Reference","Interfaces"]},{"i":1788,"t":"Interface: IBlockAttributes","u":"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes/","b":["API Reference","Interfaces"]},{"i":1807,"t":"Interface: IColumnBlock","u":"/docs/api/interfaces/headstartwp_core.react.IColumnBlock/","b":["API Reference","Interfaces"]},{"i":1828,"t":"Interface: IDataWPBlock","u":"/docs/api/interfaces/headstartwp_core.react.IDataWPBlock/","b":["API Reference","Interfaces"]},{"i":1832,"t":"Interface: IColumnsBlock","u":"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock/","b":["API Reference","Interfaces"]},{"i":1853,"t":"Interface: ICodeBlock","u":"/docs/api/interfaces/headstartwp_core.react.ICodeBlock/","b":["API Reference","Interfaces"]},{"i":1874,"t":"Interface: IGroupBlock","u":"/docs/api/interfaces/headstartwp_core.react.IGroupBlock/","b":["API Reference","Interfaces"]},{"i":1895,"t":"Interface: ICoverBlock","u":"/docs/api/interfaces/headstartwp_core.react.ICoverBlock/","b":["API Reference","Interfaces"]},{"i":1916,"t":"Interface: IHeadingBlock","u":"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock/","b":["API Reference","Interfaces"]},{"i":1937,"t":"Interface: IImageBlock","u":"/docs/api/interfaces/headstartwp_core.react.IImageBlock/","b":["API Reference","Interfaces"]},{"i":1958,"t":"Interface: ImageBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps/","b":["API Reference","Interfaces"]},{"i":1989,"t":"Interface: IMediaTextBlock","u":"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock/","b":["API Reference","Interfaces"]},{"i":2010,"t":"Interface: IFileBlock","u":"/docs/api/interfaces/headstartwp_core.react.IFileBlock/","b":["API Reference","Interfaces"]},{"i":2031,"t":"Interface: IListBlock","u":"/docs/api/interfaces/headstartwp_core.react.IListBlock/","b":["API Reference","Interfaces"]},{"i":2052,"t":"Interface: IPreformattedBlock","u":"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock/","b":["API Reference","Interfaces"]},{"i":2073,"t":"Interface: IParagraphBlock","u":"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock/","b":["API Reference","Interfaces"]},{"i":2094,"t":"Interface: ISeparatorBlock","u":"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock/","b":["API Reference","Interfaces"]},{"i":2115,"t":"Interface: IQuoteBlock","u":"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock/","b":["API Reference","Interfaces"]},{"i":2136,"t":"Interface: IYoutubeLiteBlock","u":"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock/","b":["API Reference","Interfaces"]},{"i":2157,"t":"Interface: IPullQuoteBlock","u":"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock/","b":["API Reference","Interfaces"]},{"i":2178,"t":"Interface: ISpacerBlock","u":"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock/","b":["API Reference","Interfaces"]},{"i":2199,"t":"Interface: ITableBlock","u":"/docs/api/interfaces/headstartwp_core.react.ITableBlock/","b":["API Reference","Interfaces"]},{"i":2220,"t":"Interface: ListBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.ListBlockProps/","b":["API Reference","Interfaces"]},{"i":2241,"t":"Interface: MediaTextBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps/","b":["API Reference","Interfaces"]},{"i":2276,"t":"Interface: IVerseBlock","u":"/docs/api/interfaces/headstartwp_core.react.IVerseBlock/","b":["API Reference","Interfaces"]},{"i":2297,"t":"Interface: PreformattedBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps/","b":["API Reference","Interfaces"]},{"i":2316,"t":"Interface: PullQuoteBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps/","b":["API Reference","Interfaces"]},{"i":2341,"t":"Interface: SeparatorBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps/","b":["API Reference","Interfaces"]},{"i":2360,"t":"Interface: SafeHtmlProps","u":"/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps/","b":["API Reference","Interfaces"]},{"i":2367,"t":"Interface: QuoteBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps/","b":["API Reference","Interfaces"]},{"i":2386,"t":"Interface: ParagraphBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps/","b":["API Reference","Interfaces"]},{"i":2407,"t":"Interface: SpacerBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps/","b":["API Reference","Interfaces"]},{"i":2428,"t":"Interface: SettingsCustomAdditionalProperties","u":"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties/","b":["API Reference","Interfaces"]},{"i":2432,"t":"Interface: SettingsProperties","u":"/docs/api/interfaces/headstartwp_core.react.SettingsProperties/","b":["API Reference","Interfaces"]},{"i":2451,"t":"Interface: StylesElementsPropertiesComplete","u":"/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete/","b":["API Reference","Interfaces"]},{"i":2468,"t":"Interface: StylesProperties","u":"/docs/api/interfaces/headstartwp_core.react.StylesProperties/","b":["API Reference","Interfaces"]},{"i":2481,"t":"Interface: useAppSettingsResponse","u":"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse/","b":["API Reference","Interfaces"]},{"i":2496,"t":"Interface: TableBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.TableBlockProps/","b":["API Reference","Interfaces"]},{"i":2517,"t":"Interface: useFetchOptions","u":"/docs/api/interfaces/headstartwp_core.react.useFetchOptions/","b":["API Reference","Interfaces"]},{"i":2522,"t":"Interface: usePostOrPostResponse","u":"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse/","b":["API Reference","Interfaces"]},{"i":2541,"t":"Interface: useMenuResponse","u":"/docs/api/interfaces/headstartwp_core.react.useMenuResponse/","b":["API Reference","Interfaces"]},{"i":2554,"t":"Interface: usePostResponse","u":"/docs/api/interfaces/headstartwp_core.react.usePostResponse/","b":["API Reference","Interfaces"]},{"i":2569,"t":"Interface: Typography","u":"/docs/api/interfaces/headstartwp_core.react.Typography/","b":["API Reference","Interfaces"]},{"i":2594,"t":"Interface: useSearchResponse","u":"/docs/api/interfaces/headstartwp_core.react.useSearchResponse/","b":["API Reference","Interfaces"]},{"i":2609,"t":"Interface: useTermsResponse","u":"/docs/api/interfaces/headstartwp_core.react.useTermsResponse/","b":["API Reference","Interfaces"]},{"i":2624,"t":"Interface: VerseBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps/","b":["API Reference","Interfaces"]},{"i":2643,"t":"Interface: usePostsResponse","u":"/docs/api/interfaces/headstartwp_core.react.usePostsResponse/","b":["API Reference","Interfaces"]},{"i":2660,"t":"Interface: WpThemeJSON","u":"/docs/api/interfaces/headstartwp_core.react.WpThemeJSON/","b":["API Reference","Interfaces"]},{"i":2675,"t":"Interface: SearchEntity","u":"/docs/api/interfaces/headstartwp_core.SearchEntity/","b":["API Reference","Interfaces"]},{"i":2690,"t":"Interface: YoutubeLiteBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps/","b":["API Reference","Interfaces"]},{"i":2713,"t":"Interface: Rendered","u":"/docs/api/interfaces/headstartwp_core.Rendered/","b":["API Reference","Interfaces"]},{"i":2720,"t":"Interface: TypeEntity","u":"/docs/api/interfaces/headstartwp_core.TypeEntity/","b":["API Reference","Interfaces"]},{"i":2741,"t":"Interface: RevisionEntity","u":"/docs/api/interfaces/headstartwp_core.RevisionEntity/","b":["API Reference","Interfaces"]},{"i":2788,"t":"Interface: TaxonomyEntity","u":"/docs/api/interfaces/headstartwp_core.TaxonomyEntity/","b":["API Reference","Interfaces"]},{"i":2809,"t":"Interface: YoastSEOIntegration","u":"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration/","b":["API Reference","Interfaces"]},{"i":2816,"t":"Interface: TaxonomyArchiveParams","u":"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams/","b":["API Reference","Interfaces"]},{"i":2851,"t":"Interface: TermEntity","u":"/docs/api/interfaces/headstartwp_core.TermEntity/","b":["API Reference","Interfaces"]},{"i":2878,"t":"Interface: ImageProps","u":"/docs/api/interfaces/headstartwp_next.ImageProps/","b":["API Reference","Interfaces"]},{"i":2911,"t":"Interface: FetchHookDataOptions","u":"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions/","b":["API Reference","Interfaces"]},{"i":2922,"t":"Interface: LinkBlockProps","u":"/docs/api/interfaces/headstartwp_next.LinkBlockProps/","b":["API Reference","Interfaces"]},{"i":2945,"t":"Interface: VerifyTokenParams","u":"/docs/api/interfaces/headstartwp_core.VerifyTokenParams/","b":["API Reference","Interfaces"]},{"i":2958,"t":"Namespace: config","u":"/docs/api/namespaces/headstartwp_next.config/","b":["API Reference","Namespaces"]},{"i":2969,"t":"Namespace: middlewares","u":"/docs/api/namespaces/headstartwp_next.middlewares/","b":["API Reference","Namespaces"]},{"i":2978,"t":"Introduction","u":"/docs/learn/","b":["Docs"]},{"i":2980,"t":"Introduction","u":"/docs/learn/data-fetching/","b":["Docs","Data Fetching"]},{"i":2986,"t":"Prefetching data on the server","u":"/docs/learn/data-fetching/prefetching/","b":["Docs","Data Fetching"]},{"i":2988,"t":"Custom hooks","u":"/docs/learn/data-fetching/creating-your-own-custom-hooks/","b":["Docs","Data Fetching"]},{"i":2996,"t":"The useAuthorArchive Hook","u":"/docs/learn/data-fetching/useauthorarchive/","b":["Docs","Data Fetching"]},{"i":3002,"t":"The usePostOrPosts hook","u":"/docs/learn/data-fetching/use-post-or-posts/","b":["Docs","Data Fetching"]},{"i":3014,"t":"The usePost hook","u":"/docs/learn/data-fetching/usepost/","b":["Docs","Data Fetching"]},{"i":3022,"t":"The useSearch hook","u":"/docs/learn/data-fetching/usesearch/","b":["Docs","Data Fetching"]},{"i":3030,"t":"Module: @headstartwp/core","u":"/docs/api/modules/headstartwp_core/","b":["API Reference","Modules"]},{"i":3204,"t":"The useTerms hook","u":"/docs/learn/data-fetching/useterms/","b":["Docs","Data Fetching"]},{"i":3208,"t":"The useSeo hook","u":"/docs/learn/data-fetching/useSeo/","b":["Docs","Data Fetching"]},{"i":3212,"t":"The usePosts hook","u":"/docs/learn/data-fetching/useposts/","b":["Docs","Data Fetching"]},{"i":3224,"t":"Installing WordPress Plugin","u":"/docs/learn/getting-started/installing-wordpress-plugin/","b":["Docs","Getting Started"]},{"i":3231,"t":"Quick Setup","u":"/docs/learn/getting-started/quick-setup/","b":["Docs","Getting Started"]},{"i":3241,"t":"Configuring the Framework","u":"/docs/learn/getting-started/headless-config/","b":["Docs","Getting Started"]},{"i":3265,"t":"Namespace: react","u":"/docs/api/namespaces/headstartwp_core.react/","b":["API Reference","Namespaces"]},{"i":3468,"t":"Quick Introduction to the Framework","u":"/docs/learn/getting-started/quick-tutorial/","b":["Docs","Getting Started"]},{"i":3479,"t":"A/B Testing SPA vs MPA navigation","u":"/docs/learn/Guides/ab-test-link/","b":["Docs","Guides"]},{"i":3481,"t":"Linaria (CSS-in-JS)","u":"/docs/learn/Guides/linaria/","b":["Docs","Guides"]},{"i":3483,"t":"TypeScript","u":"/docs/learn/Guides/typescript/","b":["Docs","Guides"]},{"i":3484,"t":"Setting up the framework from scratch","u":"/docs/learn/getting-started/setting-up-manually/","b":["Docs","Getting Started"]},{"i":3504,"t":"Rendering Custom Blocks","u":"/docs/learn/gutenberg/rendering-custom-blocks/","b":["Docs","Gutenberg"]},{"i":3506,"t":"Basic Auth","u":"/docs/learn/wordpress-integration/basic-auth/","b":["Docs","WordPress Integration"]},{"i":3508,"t":"Implementing a Youtube Facade","u":"/docs/learn/Guides/youtube-facade/","b":["Docs","Guides"]},{"i":3510,"t":"Escaping & Sanitization","u":"/docs/learn/utilities/sanitization/","b":["Docs","Utilities"]},{"i":3524,"t":"Feeds","u":"/docs/learn/wordpress-integration/feeds/","b":["Docs","WordPress Integration"]},{"i":3528,"t":"Gutenberg","u":"/docs/learn/wordpress-integration/gutenberg/","b":["Docs","WordPress Integration"]},{"i":3542,"t":"Multisite","u":"/docs/learn/wordpress-integration/multisite/","b":["Docs","WordPress Integration"]},{"i":3555,"t":"Rendering Blocks","u":"/docs/learn/gutenberg/rendering-blocks/","b":["Docs","Gutenberg"]},{"i":3574,"t":"Rendering Blocks in React Native","u":"/docs/learn/gutenberg/rendering-blocks-in-react-native/","b":["Docs","Gutenberg"]},{"i":3587,"t":"Previews","u":"/docs/learn/wordpress-integration/previews/","b":["Docs","WordPress Integration"]},{"i":3595,"t":"Module: @headstartwp/next","u":"/docs/api/modules/headstartwp_next/","b":["API Reference","Modules"]},{"i":3710,"t":"On-demand ISR revalidation","u":"/docs/learn/wordpress-integration/revalidate/","b":["Docs","WordPress Integration"]},{"i":3727,"t":"Polylang Integration","u":"/docs/learn/wordpress-integration/polylang/","b":["Docs","WordPress Integration"]}],"index":{"version":"2.3.9","fields":["t"],"fieldVectors":[["t/1",[0,5.957]],["t/4",[1,2.208,2,4.78]],["t/27",[1,1.844,3,3.991,4,2.616]],["t/78",[1,2.208,5,4.78]],["t/134",[1,2.208,6,4.78]],["t/157",[1,2.208,7,4.78]],["t/195",[1,2.208,8,4.78]],["t/218",[1,1.844,4,2.616,9,3.991]],["t/273",[1,2.208,10,4.78]],["t/296",[1,2.208,11,4.78]],["t/319",[1,2.208,12,4.78]],["t/365",[1,1.844,4,2.616,13,3.991]],["t/420",[1,1.583,4,2.245,14,3.426,15,3.051]],["t/481",[1,1.844,4,2.616,16,3.991]],["t/536",[1,2.208,17,4.78]],["t/574",[1,1.844,4,2.616,18,3.991]],["t/637",[1,1.844,4,2.616,19,3.991]],["t/690",[20,4.78,21,4.78]],["t/701",[22,0.446,23,4.78]],["t/726",[22,0.446,24,4.78]],["t/743",[22,0.446,25,4.78]],["t/754",[1,2.208,26,4.78]],["t/803",[22,0.446,27,4.78]],["t/842",[22,0.446,28,4.78]],["t/855",[22,0.446,29,4.78]],["t/918",[22,0.446,30,4.78]],["t/927",[22,0.446,31,4.78]],["t/938",[22,0.446,32,4.78]],["t/949",[22,0.446,33,4.78]],["t/960",[22,0.446,34,4.257]],["t/967",[22,0.446,35,4.78]],["t/976",[22,0.446,36,4.78]],["t/985",[22,0.446,37,4.78]],["t/992",[22,0.446,38,4.78]],["t/1047",[22,0.446,39,4.78]],["t/1086",[22,0.446,40,4.78]],["t/1145",[22,0.446,41,4.78]],["t/1170",[22,0.446,42,4.78]],["t/1233",[22,0.446,43,4.78]],["t/1252",[22,0.446,44,4.78]],["t/1281",[22,0.446,45,4.78]],["t/1310",[22,0.446,46,4.78]],["t/1351",[22,0.446,47,4.78]],["t/1368",[1,1.583,15,3.051,48,3.426,49,3.426]],["t/1419",[22,0.446,50,4.78]],["t/1430",[22,0.446,51,4.78]],["t/1451",[22,0.446,52,4.78]],["t/1482",[22,0.446,53,4.78]],["t/1501",[22,0.446,54,4.78]],["t/1520",[22,0.446,55,4.78]],["t/1539",[22,0.446,56,4.78]],["t/1558",[22,0.446,57,4.78]],["t/1569",[22,0.446,58,4.78]],["t/1606",[22,0.446,59,4.78]],["t/1631",[22,0.446,60,4.78]],["t/1640",[22,0.446,61,4.78]],["t/1663",[22,0.446,62,4.78]],["t/1668",[22,0.446,63,4.78]],["t/1681",[22,0.446,64,4.78]],["t/1702",[22,0.446,65,4.78]],["t/1723",[22,0.446,66,4.78]],["t/1744",[22,0.446,67,4.78]],["t/1765",[22,0.446,68,4.78]],["t/1788",[22,0.446,69,4.78]],["t/1807",[22,0.446,70,4.78]],["t/1828",[22,0.446,71,4.78]],["t/1832",[22,0.446,72,4.78]],["t/1853",[22,0.446,73,4.78]],["t/1874",[22,0.446,74,4.78]],["t/1895",[22,0.446,75,4.78]],["t/1916",[22,0.446,76,4.78]],["t/1937",[22,0.446,77,4.78]],["t/1958",[22,0.446,78,4.78]],["t/1989",[22,0.446,79,4.78]],["t/2010",[22,0.446,80,4.78]],["t/2031",[22,0.446,81,4.78]],["t/2052",[22,0.446,82,4.78]],["t/2073",[22,0.446,83,4.78]],["t/2094",[22,0.446,84,4.78]],["t/2115",[22,0.446,85,4.78]],["t/2136",[22,0.446,86,4.78]],["t/2157",[22,0.446,87,4.78]],["t/2178",[22,0.446,88,4.78]],["t/2199",[22,0.446,89,4.78]],["t/2220",[22,0.446,90,4.78]],["t/2241",[22,0.446,91,4.78]],["t/2276",[22,0.446,92,4.78]],["t/2297",[22,0.446,93,4.78]],["t/2316",[22,0.446,94,4.78]],["t/2341",[22,0.446,95,4.78]],["t/2360",[22,0.446,96,4.78]],["t/2367",[22,0.446,97,4.78]],["t/2386",[22,0.446,98,4.78]],["t/2407",[22,0.446,99,4.78]],["t/2428",[22,0.446,100,4.78]],["t/2432",[22,0.446,101,4.78]],["t/2451",[22,0.446,102,4.78]],["t/2468",[22,0.446,103,4.78]],["t/2481",[22,0.446,104,4.78]],["t/2496",[22,0.446,105,4.78]],["t/2517",[22,0.446,106,4.78]],["t/2522",[22,0.446,107,4.78]],["t/2541",[22,0.446,108,4.78]],["t/2554",[22,0.446,109,4.78]],["t/2569",[22,0.446,110,4.78]],["t/2594",[22,0.446,111,4.78]],["t/2609",[22,0.446,112,4.78]],["t/2624",[22,0.446,113,4.78]],["t/2643",[22,0.446,114,4.78]],["t/2660",[22,0.446,115,4.78]],["t/2675",[22,0.446,116,4.78]],["t/2690",[22,0.446,117,4.78]],["t/2713",[22,0.446,118,3.655]],["t/2720",[22,0.446,119,4.78]],["t/2741",[22,0.446,120,4.78]],["t/2788",[22,0.446,121,4.78]],["t/2809",[22,0.446,122,4.78]],["t/2816",[22,0.446,123,4.78]],["t/2851",[22,0.446,124,4.78]],["t/2878",[22,0.446,125,4.78]],["t/2911",[22,0.372,126,3.991,127,3.991]],["t/2922",[22,0.446,128,4.78]],["t/2945",[22,0.446,129,4.78]],["t/2958",[130,3.913,131,4.78]],["t/2969",[130,3.913,132,4.78]],["t/2978",[133,4.876]],["t/2980",[133,4.876]],["t/2986",[134,3.991,135,3.991,136,3.991]],["t/2988",[137,4.257,138,3.004]],["t/2996",[138,3.004,139,4.78]],["t/3002",[138,3.004,140,4.78]],["t/3014",[138,3.004,141,4.257]],["t/3022",[138,3.004,142,4.78]],["t/3030",[143,4.257,144,4.78]],["t/3204",[138,3.004,145,4.78]],["t/3208",[138,3.004,146,4.78]],["t/3212",[138,3.004,141,4.257]],["t/3224",[147,3.991,148,3.991,149,3.991]],["t/3231",[150,4.257,151,4.78]],["t/3241",[152,4.78,153,3.913]],["t/3265",[130,3.913,154,4.257]],["t/3468",[133,3.267,150,3.555,153,3.267]],["t/3479",[155,2.67,156,2.67,157,2.67,158,2.67,159,2.67,160,2.67]],["t/3481",[161,3.991,162,3.991,163,3.991]],["t/3483",[164,5.957]],["t/3484",[153,2.804,165,3.426,166,3.426,167,3.426]],["t/3504",[118,3.052,137,3.555,168,3.267]],["t/3506",[169,4.78,170,4.78]],["t/3508",[171,3.991,172,3.991,173,3.991]],["t/3510",[174,3.991,175,3.991,176,3.991]],["t/3524",[177,5.957]],["t/3528",[178,5.957]],["t/3542",[179,5.957]],["t/3555",[118,3.655,168,3.913]],["t/3574",[118,2.62,154,3.051,168,2.804,180,3.426]],["t/3587",[181,5.957]],["t/3595",[143,4.257,182,4.78]],["t/3710",[183,3.991,184,3.991,185,3.991]],["t/3727",[34,4.257,186,4.78]]],"invertedIndex":[["",{"_index":175,"t":{"3510":{"position":[[9,1]]}}}],["a/b",{"_index":155,"t":{"3479":{"position":[[0,3]]}}}],["abstractfetchstrategy<",{"_index":48,"t":{"1368":{"position":[[7,24]]}}}],["appent",{"_index":24,"t":{"726":{"position":[[11,9]]}}}],["appsettingsstrategy any Type declaration​ ▸ (err, stackTraces): any Optional override for formatting stack traces See https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces Parameters​ Name Type err Error stackTraces CallSite[] Returns​ any Inherited from​ Error.prepareStackTrace Defined in​ node_modules/@types/node/globals.d.ts:140","s":"prepareStackTrace","u":"/docs/api/classes/headstartwp_core.ConfigError/","h":"#preparestacktrace","p":4},{"i":23,"t":"▪ Static stackTraceLimit: number Inherited from​ Error.stackTraceLimit Defined in​ node_modules/@types/node/globals.d.ts:142","s":"stackTraceLimit","u":"/docs/api/classes/headstartwp_core.ConfigError/","h":"#stacktracelimit","p":4},{"i":26,"t":"▸ Static captureStackTrace(targetObject, constructorOpt?): void Create .stack property on a target object Parameters​ Name Type targetObject Object constructorOpt? Function Returns​ void Inherited from​ Error.captureStackTrace Defined in​ node_modules/@types/node/globals.d.ts:133","s":"captureStackTrace","u":"/docs/api/classes/headstartwp_core.ConfigError/","h":"#capturestacktrace","p":4},{"i":28,"t":"@headstartwp/core.AppSettingsStrategy The App Settings strategy is used to fetch the app settings endpoints exposed by the headless wp plugin","s":"Class: AppSettingsStrategy","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"","p":27},{"i":30,"t":"Name Type T extends AppEntity = AppEntity P extends EndpointParams = EndpointParams","s":"Type parameters","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"#type-parameters","p":27},{"i":32,"t":"AbstractFetchStrategy ↳ AppSettingsStrategy","s":"Hierarchy","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"#hierarchy","p":27},{"i":35,"t":"• new AppSettingsStrategy(baseURL?, defaultParams?) The strategy constructor Type parameters​ Name Type T extends AppEntity = AppEntity P extends EndpointParams = EndpointParams Parameters​ Name Type Description baseURL? string The base URL of the API defaultParams? Partial

(optional) list of default params Inherited from​ AbstractFetchStrategy.constructor Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:129","s":"constructor","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"#constructor","p":27},{"i":38,"t":"• baseURL: string = '' The base URL where the API is located Inherited from​ AbstractFetchStrategy.baseURL Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:115","s":"baseURL","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"#baseurl","p":27},{"i":40,"t":"• defaultParams: Partial

= {} The Default Params Inherited from​ AbstractFetchStrategy.defaultParams Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:105","s":"defaultParams","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"#defaultparams","p":27},{"i":42,"t":"• endpoint: string = '' Holds the current endpoint for the strategy Inherited from​ AbstractFetchStrategy.endpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:110","s":"endpoint","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"#endpoint","p":27},{"i":45,"t":"▸ buildEndpointURL(params): string Builds the final endpoint URL based on the passed parameters Parameters​ Name Type Description params Partial

The params to add to the request Returns​ string The endpoint URL. Inherited from​ AbstractFetchStrategy.buildEndpointURL Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:206","s":"buildEndpointURL","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"#buildendpointurl","p":27},{"i":47,"t":"▸ fetcher(url, params, options?): Promise> The default fetcher function The default fetcher function handles authentication headers and errors from the API. A custom strategy can override this function to run additional logic before or after the fetch call Parameters​ Name Type Description url string The URL to fetch params Partial

The request params options Partial The fetcher options Returns​ Promise> Inherited from​ AbstractFetchStrategy.fetcher Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:261","s":"fetcher","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"#fetcher","p":27},{"i":49,"t":"▸ filterData(data, filterOptions?): FetchResponse Filters the data returned from the API by excluding fields that are not needed in order to reduce payload size. Parameters​ Name Type Description data FetchResponse The data to filter filterOptions? FilterDataOptions Filter options Returns​ FetchResponse The filtered data Inherited from​ AbstractFetchStrategy.filterData Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:339","s":"filterData","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"#filterdata","p":27},{"i":51,"t":"▸ get(params?): Promise> This is a simple wrapper to quickly fetch data from the API given a set of params","s":"get","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"#get","p":27},{"i":53,"t":"import { PostsArchiveFetchStrategy } from '@headstartwp/core'; new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10}); Parameters​ Name Type Description params Partial

The endpoint params Returns​ Promise> Inherited from​ AbstractFetchStrategy.get Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:404","s":"Usage","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"#usage","p":27},{"i":55,"t":"▸ getAuthHeader(options?): string Parameters​ Name Type options Partial Returns​ string Inherited from​ AbstractFetchStrategy.getAuthHeader Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:227","s":"getAuthHeader","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"#getauthheader","p":27},{"i":57,"t":"▸ getCacheKey(params): Object Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites Parameters​ Name Type Description params Partial

The request params Returns​ Object The cache key object Name Type args Partial

& { sourceUrl: string } url string Inherited from​ AbstractFetchStrategy.getCacheKey Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:369","s":"getCacheKey","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"#getcachekey","p":27},{"i":59,"t":"▸ getDefaultEndpoint(): string A method that must be implemented by concrete implementations which returns the default endpoint for the strategy Returns​ string Overrides​ AbstractFetchStrategy.getDefaultEndpoint Defined in​ packages/core/src/data/strategies/AppSettingsStrategy.ts:15","s":"getDefaultEndpoint","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"#getdefaultendpoint","p":27},{"i":61,"t":"▸ getDefaultParams(): Partial

Returns​ Partial

Inherited from​ AbstractFetchStrategy.getDefaultParams Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:168","s":"getDefaultParams","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"#getdefaultparams","p":27},{"i":63,"t":"▸ getEndpoint(): string Returns the endpoint of the strategy. If no endpoint has been set at runtime, returns the default endpoint Returns​ string The current endpoint for the strategy Inherited from​ AbstractFetchStrategy.getEndpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:160","s":"getEndpoint","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"#getendpoint","p":27},{"i":65,"t":"▸ getParamsFromURL(path, params?): Partial

Returns the supported params from the URL if present. These params are passed to buildEndpointURL. If the strategy does not support mapping url params to endpoint params, it should return an empty object. Parameters​ Name Type Description path string The Path name params Partial

The non-url params Returns​ Partial

params extracted from the URL Overrides​ AbstractFetchStrategy.getParamsFromURL Defined in​ packages/core/src/data/strategies/AppSettingsStrategy.ts:20","s":"getParamsFromURL","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"#getparamsfromurl","p":27},{"i":67,"t":"▸ getQueriedObject(response, params): Object Parameters​ Name Type response FetchResponse params Partial

Returns​ Object Inherited from​ AbstractFetchStrategy.getQueriedObject Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:327","s":"getQueriedObject","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"#getqueriedobject","p":27},{"i":69,"t":"▸ isMainQuery(path, nonUrlParams): boolean Checks if this is the main query for a page Parameters​ Name Type Description path string The page name nonUrlParams Partial

The non-url params Returns​ boolean Inherited from​ AbstractFetchStrategy.isMainQuery Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:191","s":"isMainQuery","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"#ismainquery","p":27},{"i":71,"t":"▸ normalizeForCache(data, params): NormalizedDataForCache Normalize data for cache. Parameters​ Name Type Description data FetchResponse The fetch response data params Partial

The request params Returns​ NormalizedDataForCache Inherited from​ AbstractFetchStrategy.normalizeForCache Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:379","s":"normalizeForCache","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"#normalizeforcache","p":27},{"i":73,"t":"▸ prepareResponse(response, params): FetchResponse Parameters​ Name Type response FetchResponse params Partial

Returns​ FetchResponse Inherited from​ AbstractFetchStrategy.prepareResponse Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:219","s":"prepareResponse","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"#prepareresponse","p":27},{"i":75,"t":"▸ setBaseURL(url?): void Parameters​ Name Type Default value url undefined | string '' Returns​ void Inherited from​ AbstractFetchStrategy.setBaseURL Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:150","s":"setBaseURL","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"#setbaseurl","p":27},{"i":77,"t":"▸ setEndpoint(endpoint): void The strategy can switch endpoints at runtime if needed. E.g: The actual endpoint for a post depends on its post_type Parameters​ Name Type Description endpoint string The endpoint to fetch Returns​ void Inherited from​ AbstractFetchStrategy.setEndpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:146","s":"setEndpoint","u":"/docs/api/classes/headstartwp_core.AppSettingsStrategy/","h":"#setendpoint","p":27},{"i":79,"t":"@headstartwp/core.Element An element within the DOM.","s":"Class: Element","u":"/docs/api/classes/headstartwp_core.Element/","h":"","p":78},{"i":81,"t":"NodeWithChildren ↳ Element","s":"Hierarchy","u":"/docs/api/classes/headstartwp_core.Element/","h":"#hierarchy","p":78},{"i":84,"t":"• new Element(name, attribs, children?, type?) Parameters​ Name Type Description name string Name of the tag, eg. div, span. attribs Object Object mapping attribute names to attribute values. children? ChildNode[] Children of the node. type? Script | Style | Tag - Overrides​ NodeWithChildren.constructor Defined in​ node_modules/domhandler/lib/node.d.ts:178","s":"constructor","u":"/docs/api/classes/headstartwp_core.Element/","h":"#constructor","p":78},{"i":87,"t":"• attribs: Object Index signature​ ▪ [name: string]: string Defined in​ node_modules/domhandler/lib/node.d.ts:169","s":"attribs","u":"/docs/api/classes/headstartwp_core.Element/","h":"#attribs","p":78},{"i":89,"t":"• children: ChildNode[] Inherited from​ NodeWithChildren.children Defined in​ node_modules/domhandler/lib/node.d.ts:126","s":"children","u":"/docs/api/classes/headstartwp_core.Element/","h":"#children","p":78},{"i":91,"t":"• endIndex: null | number The end index of the node. Requires withEndIndices on the handler to be `true. Inherited from​ NodeWithChildren.endIndex Defined in​ node_modules/domhandler/lib/node.d.ts:39","s":"endIndex","u":"/docs/api/classes/headstartwp_core.Element/","h":"#endindex","p":78},{"i":93,"t":"• name: string Defined in​ node_modules/domhandler/lib/node.d.ts:168","s":"name","u":"/docs/api/classes/headstartwp_core.Element/","h":"#name","p":78},{"i":95,"t":"• Optional namespace: string Element namespace (parse5 only). Defined in​ node_modules/domhandler/lib/node.d.ts:196","s":"namespace","u":"/docs/api/classes/headstartwp_core.Element/","h":"#namespace","p":78},{"i":97,"t":"• next: null | ChildNode Next sibling Inherited from​ NodeWithChildren.next Defined in​ node_modules/domhandler/lib/node.d.ts:35","s":"next","u":"/docs/api/classes/headstartwp_core.Element/","h":"#next","p":78},{"i":99,"t":"• parent: null | ParentNode Parent of the node Inherited from​ NodeWithChildren.parent Defined in​ node_modules/domhandler/lib/node.d.ts:31","s":"parent","u":"/docs/api/classes/headstartwp_core.Element/","h":"#parent","p":78},{"i":101,"t":"• prev: null | ChildNode Previous sibling Inherited from​ NodeWithChildren.prev Defined in​ node_modules/domhandler/lib/node.d.ts:33","s":"prev","u":"/docs/api/classes/headstartwp_core.Element/","h":"#prev","p":78},{"i":103,"t":"• Optional sourceCodeLocation: null | TagSourceCodeLocation parse5 source code location info, with start & end tags. Available if parsing with parse5 and location info is enabled. Overrides​ NodeWithChildren.sourceCodeLocation Defined in​ node_modules/domhandler/lib/node.d.ts:187","s":"sourceCodeLocation","u":"/docs/api/classes/headstartwp_core.Element/","h":"#sourcecodelocation","p":78},{"i":105,"t":"• startIndex: null | number The start index of the node. Requires withStartIndices on the handler to be `true. Inherited from​ NodeWithChildren.startIndex Defined in​ node_modules/domhandler/lib/node.d.ts:37","s":"startIndex","u":"/docs/api/classes/headstartwp_core.Element/","h":"#startindex","p":78},{"i":107,"t":"• type: Script | Style | Tag Overrides​ NodeWithChildren.type Defined in​ node_modules/domhandler/lib/node.d.ts:172","s":"type","u":"/docs/api/classes/headstartwp_core.Element/","h":"#type","p":78},{"i":109,"t":"• Optional x-attribsNamespace: Record Element attribute namespaces (parse5 only). Defined in​ node_modules/domhandler/lib/node.d.ts:198","s":"x-attribsNamespace","u":"/docs/api/classes/headstartwp_core.Element/","h":"#x-attribsnamespace","p":78},{"i":111,"t":"• Optional x-attribsPrefix: Record Element attribute namespace-related prefixes (parse5 only). Defined in​ node_modules/domhandler/lib/node.d.ts:200","s":"x-attribsPrefix","u":"/docs/api/classes/headstartwp_core.Element/","h":"#x-attribsprefix","p":78},{"i":114,"t":"• get attributes(): Attribute[] Returns​ Attribute[] Defined in​ node_modules/domhandler/lib/node.d.ts:194","s":"attributes","u":"/docs/api/classes/headstartwp_core.Element/","h":"#attributes","p":78},{"i":116,"t":"• get childNodes(): ChildNode[] Same as children. DOM spec-compatible alias. Returns​ ChildNode[] Inherited from​ NodeWithChildren.childNodes Defined in​ node_modules/domhandler/lib/node.d.ts:139 • set childNodes(children): void Parameters​ Name Type children ChildNode[] Returns​ void Inherited from​ NodeWithChildren.childNodes Defined in​ node_modules/domhandler/lib/node.d.ts:140","s":"childNodes","u":"/docs/api/classes/headstartwp_core.Element/","h":"#childnodes","p":78},{"i":118,"t":"• get firstChild(): null | ChildNode First child of the node. Returns​ null | ChildNode Inherited from​ NodeWithChildren.firstChild Defined in​ node_modules/domhandler/lib/node.d.ts:132","s":"firstChild","u":"/docs/api/classes/headstartwp_core.Element/","h":"#firstchild","p":78},{"i":120,"t":"• get lastChild(): null | ChildNode Last child of the node. Returns​ null | ChildNode Inherited from​ NodeWithChildren.lastChild Defined in​ node_modules/domhandler/lib/node.d.ts:134","s":"lastChild","u":"/docs/api/classes/headstartwp_core.Element/","h":"#lastchild","p":78},{"i":122,"t":"• get nextSibling(): null | ChildNode Same as next. DOM spec-compatible alias. Returns​ null | ChildNode Inherited from​ NodeWithChildren.nextSibling Defined in​ node_modules/domhandler/lib/node.d.ts:67 • set nextSibling(next): void Parameters​ Name Type next null | ChildNode Returns​ void Inherited from​ NodeWithChildren.nextSibling Defined in​ node_modules/domhandler/lib/node.d.ts:68","s":"nextSibling","u":"/docs/api/classes/headstartwp_core.Element/","h":"#nextsibling","p":78},{"i":124,"t":"• get nodeType(): 1 Returns​ 1 Overrides​ NodeWithChildren.nodeType Defined in​ node_modules/domhandler/lib/node.d.ts:181","s":"nodeType","u":"/docs/api/classes/headstartwp_core.Element/","h":"#nodetype","p":78},{"i":126,"t":"• get parentNode(): null | ParentNode Same as parent. DOM spec-compatible alias. Returns​ null | ParentNode Inherited from​ NodeWithChildren.parentNode Defined in​ node_modules/domhandler/lib/node.d.ts:55 • set parentNode(parent): void Parameters​ Name Type parent null | ParentNode Returns​ void Inherited from​ NodeWithChildren.parentNode Defined in​ node_modules/domhandler/lib/node.d.ts:56","s":"parentNode","u":"/docs/api/classes/headstartwp_core.Element/","h":"#parentnode","p":78},{"i":128,"t":"• get previousSibling(): null | ChildNode Same as prev. DOM spec-compatible alias. Returns​ null | ChildNode Inherited from​ NodeWithChildren.previousSibling Defined in​ node_modules/domhandler/lib/node.d.ts:61 • set previousSibling(prev): void Parameters​ Name Type prev null | ChildNode Returns​ void Inherited from​ NodeWithChildren.previousSibling Defined in​ node_modules/domhandler/lib/node.d.ts:62","s":"previousSibling","u":"/docs/api/classes/headstartwp_core.Element/","h":"#previoussibling","p":78},{"i":130,"t":"• get tagName(): string Same as name. DOM spec-compatible alias. Returns​ string Defined in​ node_modules/domhandler/lib/node.d.ts:192 • set tagName(name): void Parameters​ Name Type name string Returns​ void Defined in​ node_modules/domhandler/lib/node.d.ts:193","s":"tagName","u":"/docs/api/classes/headstartwp_core.Element/","h":"#tagname","p":78},{"i":133,"t":"▸ cloneNode(this, recursive?): T Clone this node, and optionally its children. Type parameters​ Name Type T extends Node Parameters​ Name Type Description this T - recursive? boolean Clone child nodes as well. Returns​ T A clone of the node. Inherited from​ NodeWithChildren.cloneNode Defined in​ node_modules/domhandler/lib/node.d.ts:75","s":"cloneNode","u":"/docs/api/classes/headstartwp_core.Element/","h":"#clonenode","p":78},{"i":135,"t":"@headstartwp/core.EndpointError","s":"Class: EndpointError","u":"/docs/api/classes/headstartwp_core.EndpointError/","h":"","p":134},{"i":137,"t":"Error ↳ EndpointError","s":"Hierarchy","u":"/docs/api/classes/headstartwp_core.EndpointError/","h":"#hierarchy","p":134},{"i":140,"t":"• new EndpointError(message) Parameters​ Name Type message string Overrides​ Error.constructor Defined in​ packages/core/src/utils/errors.ts:25","s":"constructor","u":"/docs/api/classes/headstartwp_core.EndpointError/","h":"#constructor","p":134},{"i":143,"t":"• Optional cause: unknown Inherited from​ Error.cause Defined in​ docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26","s":"cause","u":"/docs/api/classes/headstartwp_core.EndpointError/","h":"#cause","p":134},{"i":145,"t":"• message: string Inherited from​ Error.message Defined in​ docs/node_modules/typescript/lib/lib.es5.d.ts:1054","s":"message","u":"/docs/api/classes/headstartwp_core.EndpointError/","h":"#message","p":134},{"i":147,"t":"• name: string Inherited from​ Error.name Defined in​ docs/node_modules/typescript/lib/lib.es5.d.ts:1053","s":"name","u":"/docs/api/classes/headstartwp_core.EndpointError/","h":"#name","p":134},{"i":149,"t":"• Optional stack: string Inherited from​ Error.stack Defined in​ docs/node_modules/typescript/lib/lib.es5.d.ts:1055 node_modules/@types/node/globals.d.ts:127","s":"stack","u":"/docs/api/classes/headstartwp_core.EndpointError/","h":"#stack","p":134},{"i":151,"t":"▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any Type declaration​ ▸ (err, stackTraces): any Optional override for formatting stack traces See https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces Parameters​ Name Type err Error stackTraces CallSite[] Returns​ any Inherited from​ Error.prepareStackTrace Defined in​ node_modules/@types/node/globals.d.ts:140","s":"prepareStackTrace","u":"/docs/api/classes/headstartwp_core.EndpointError/","h":"#preparestacktrace","p":134},{"i":153,"t":"▪ Static stackTraceLimit: number Inherited from​ Error.stackTraceLimit Defined in​ node_modules/@types/node/globals.d.ts:142","s":"stackTraceLimit","u":"/docs/api/classes/headstartwp_core.EndpointError/","h":"#stacktracelimit","p":134},{"i":156,"t":"▸ Static captureStackTrace(targetObject, constructorOpt?): void Create .stack property on a target object Parameters​ Name Type targetObject Object constructorOpt? Function Returns​ void Inherited from​ Error.captureStackTrace Defined in​ node_modules/@types/node/globals.d.ts:133","s":"captureStackTrace","u":"/docs/api/classes/headstartwp_core.EndpointError/","h":"#capturestacktrace","p":134},{"i":158,"t":"@headstartwp/core.Comment Comments within the document.","s":"Class: Comment","u":"/docs/api/classes/headstartwp_core.Comment/","h":"","p":157},{"i":160,"t":"DataNode ↳ Comment","s":"Hierarchy","u":"/docs/api/classes/headstartwp_core.Comment/","h":"#hierarchy","p":157},{"i":163,"t":"• new Comment(data) Parameters​ Name Type Description data string The content of the data node Inherited from​ DataNode.constructor Defined in​ node_modules/domhandler/lib/node.d.ts:85","s":"constructor","u":"/docs/api/classes/headstartwp_core.Comment/","h":"#constructor","p":157},{"i":166,"t":"• data: string Inherited from​ DataNode.data Defined in​ node_modules/domhandler/lib/node.d.ts:81","s":"data","u":"/docs/api/classes/headstartwp_core.Comment/","h":"#data","p":157},{"i":168,"t":"• endIndex: null | number The end index of the node. Requires withEndIndices on the handler to be `true. Inherited from​ DataNode.endIndex Defined in​ node_modules/domhandler/lib/node.d.ts:39","s":"endIndex","u":"/docs/api/classes/headstartwp_core.Comment/","h":"#endindex","p":157},{"i":170,"t":"• next: null | ChildNode Next sibling Inherited from​ DataNode.next Defined in​ node_modules/domhandler/lib/node.d.ts:35","s":"next","u":"/docs/api/classes/headstartwp_core.Comment/","h":"#next","p":157},{"i":172,"t":"• parent: null | ParentNode Parent of the node Inherited from​ DataNode.parent Defined in​ node_modules/domhandler/lib/node.d.ts:31","s":"parent","u":"/docs/api/classes/headstartwp_core.Comment/","h":"#parent","p":157},{"i":174,"t":"• prev: null | ChildNode Previous sibling Inherited from​ DataNode.prev Defined in​ node_modules/domhandler/lib/node.d.ts:33","s":"prev","u":"/docs/api/classes/headstartwp_core.Comment/","h":"#prev","p":157},{"i":176,"t":"• Optional sourceCodeLocation: null | SourceCodeLocation parse5 source code location info. Available if parsing with parse5 and location info is enabled. Inherited from​ DataNode.sourceCodeLocation Defined in​ node_modules/domhandler/lib/node.d.ts:45","s":"sourceCodeLocation","u":"/docs/api/classes/headstartwp_core.Comment/","h":"#sourcecodelocation","p":157},{"i":178,"t":"• startIndex: null | number The start index of the node. Requires withStartIndices on the handler to be `true. Inherited from​ DataNode.startIndex Defined in​ node_modules/domhandler/lib/node.d.ts:37","s":"startIndex","u":"/docs/api/classes/headstartwp_core.Comment/","h":"#startindex","p":157},{"i":180,"t":"• type: Comment Overrides​ DataNode.type Defined in​ node_modules/domhandler/lib/node.d.ts:104","s":"type","u":"/docs/api/classes/headstartwp_core.Comment/","h":"#type","p":157},{"i":183,"t":"• get nextSibling(): null | ChildNode Same as next. DOM spec-compatible alias. Returns​ null | ChildNode Inherited from​ DataNode.nextSibling Defined in​ node_modules/domhandler/lib/node.d.ts:67 • set nextSibling(next): void Parameters​ Name Type next null | ChildNode Returns​ void Inherited from​ DataNode.nextSibling Defined in​ node_modules/domhandler/lib/node.d.ts:68","s":"nextSibling","u":"/docs/api/classes/headstartwp_core.Comment/","h":"#nextsibling","p":157},{"i":185,"t":"• get nodeType(): 8 Returns​ 8 Overrides​ DataNode.nodeType Defined in​ node_modules/domhandler/lib/node.d.ts:105","s":"nodeType","u":"/docs/api/classes/headstartwp_core.Comment/","h":"#nodetype","p":157},{"i":187,"t":"• get nodeValue(): string Same as data. DOM spec-compatible alias. Returns​ string Inherited from​ DataNode.nodeValue Defined in​ node_modules/domhandler/lib/node.d.ts:90 • set nodeValue(data): void Parameters​ Name Type data string Returns​ void Inherited from​ DataNode.nodeValue Defined in​ node_modules/domhandler/lib/node.d.ts:91","s":"nodeValue","u":"/docs/api/classes/headstartwp_core.Comment/","h":"#nodevalue","p":157},{"i":189,"t":"• get parentNode(): null | ParentNode Same as parent. DOM spec-compatible alias. Returns​ null | ParentNode Inherited from​ DataNode.parentNode Defined in​ node_modules/domhandler/lib/node.d.ts:55 • set parentNode(parent): void Parameters​ Name Type parent null | ParentNode Returns​ void Inherited from​ DataNode.parentNode Defined in​ node_modules/domhandler/lib/node.d.ts:56","s":"parentNode","u":"/docs/api/classes/headstartwp_core.Comment/","h":"#parentnode","p":157},{"i":191,"t":"• get previousSibling(): null | ChildNode Same as prev. DOM spec-compatible alias. Returns​ null | ChildNode Inherited from​ DataNode.previousSibling Defined in​ node_modules/domhandler/lib/node.d.ts:61 • set previousSibling(prev): void Parameters​ Name Type prev null | ChildNode Returns​ void Inherited from​ DataNode.previousSibling Defined in​ node_modules/domhandler/lib/node.d.ts:62","s":"previousSibling","u":"/docs/api/classes/headstartwp_core.Comment/","h":"#previoussibling","p":157},{"i":194,"t":"▸ cloneNode(this, recursive?): T Clone this node, and optionally its children. Type parameters​ Name Type T extends Node Parameters​ Name Type Description this T - recursive? boolean Clone child nodes as well. Returns​ T A clone of the node. Inherited from​ DataNode.cloneNode Defined in​ node_modules/domhandler/lib/node.d.ts:75","s":"cloneNode","u":"/docs/api/classes/headstartwp_core.Comment/","h":"#clonenode","p":157},{"i":196,"t":"@headstartwp/core.FrameworkError","s":"Class: FrameworkError","u":"/docs/api/classes/headstartwp_core.FrameworkError/","h":"","p":195},{"i":198,"t":"Error ↳ FrameworkError","s":"Hierarchy","u":"/docs/api/classes/headstartwp_core.FrameworkError/","h":"#hierarchy","p":195},{"i":201,"t":"• new FrameworkError(message) Parameters​ Name Type message string Overrides​ Error.constructor Defined in​ packages/core/src/utils/errors.ts:32","s":"constructor","u":"/docs/api/classes/headstartwp_core.FrameworkError/","h":"#constructor","p":195},{"i":204,"t":"• Optional cause: unknown Inherited from​ Error.cause Defined in​ docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26","s":"cause","u":"/docs/api/classes/headstartwp_core.FrameworkError/","h":"#cause","p":195},{"i":206,"t":"• message: string Inherited from​ Error.message Defined in​ docs/node_modules/typescript/lib/lib.es5.d.ts:1054","s":"message","u":"/docs/api/classes/headstartwp_core.FrameworkError/","h":"#message","p":195},{"i":208,"t":"• name: string Inherited from​ Error.name Defined in​ docs/node_modules/typescript/lib/lib.es5.d.ts:1053","s":"name","u":"/docs/api/classes/headstartwp_core.FrameworkError/","h":"#name","p":195},{"i":210,"t":"• Optional stack: string Inherited from​ Error.stack Defined in​ docs/node_modules/typescript/lib/lib.es5.d.ts:1055 node_modules/@types/node/globals.d.ts:127","s":"stack","u":"/docs/api/classes/headstartwp_core.FrameworkError/","h":"#stack","p":195},{"i":212,"t":"▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any Type declaration​ ▸ (err, stackTraces): any Optional override for formatting stack traces See https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces Parameters​ Name Type err Error stackTraces CallSite[] Returns​ any Inherited from​ Error.prepareStackTrace Defined in​ node_modules/@types/node/globals.d.ts:140","s":"prepareStackTrace","u":"/docs/api/classes/headstartwp_core.FrameworkError/","h":"#preparestacktrace","p":195},{"i":214,"t":"▪ Static stackTraceLimit: number Inherited from​ Error.stackTraceLimit Defined in​ node_modules/@types/node/globals.d.ts:142","s":"stackTraceLimit","u":"/docs/api/classes/headstartwp_core.FrameworkError/","h":"#stacktracelimit","p":195},{"i":217,"t":"▸ Static captureStackTrace(targetObject, constructorOpt?): void Create .stack property on a target object Parameters​ Name Type targetObject Object constructorOpt? Function Returns​ void Inherited from​ Error.captureStackTrace Defined in​ node_modules/@types/node/globals.d.ts:133","s":"captureStackTrace","u":"/docs/api/classes/headstartwp_core.FrameworkError/","h":"#capturestacktrace","p":195},{"i":219,"t":"@headstartwp/core.AuthorArchiveFetchStrategy The AuthorArchiveFetchStrategy extends the PostsArchiveFetchStrategy and performs author archive requests This strategy supports extracting endpoint params from url E.g: /author-name/ maps to { author: 'author-name' } /author-name/page/2 maps to { author: 'author-name', page: 2 }","s":"Class: AuthorArchiveFetchStrategy","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"","p":218},{"i":221,"t":"Name Type T extends PostEntity = PostEntity P extends PostsArchiveParams = PostsArchiveParams","s":"Type parameters","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#type-parameters","p":218},{"i":223,"t":"PostsArchiveFetchStrategy ↳ AuthorArchiveFetchStrategy","s":"Hierarchy","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#hierarchy","p":218},{"i":226,"t":"• new AuthorArchiveFetchStrategy(baseURL?, defaultParams?) The strategy constructor Type parameters​ Name Type T extends PostEntity = PostEntity P extends PostsArchiveParams = PostsArchiveParams Parameters​ Name Type Description baseURL? string The base URL of the API defaultParams? Partial

(optional) list of default params Inherited from​ PostsArchiveFetchStrategy.constructor Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:129","s":"constructor","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#constructor","p":218},{"i":229,"t":"• baseURL: string = '' The base URL where the API is located Inherited from​ PostsArchiveFetchStrategy.baseURL Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:115","s":"baseURL","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#baseurl","p":218},{"i":231,"t":"• defaultParams: Partial

= {} The Default Params Inherited from​ PostsArchiveFetchStrategy.defaultParams Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:105","s":"defaultParams","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#defaultparams","p":218},{"i":233,"t":"• endpoint: string = '' Holds the current endpoint for the strategy Inherited from​ PostsArchiveFetchStrategy.endpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:110","s":"endpoint","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#endpoint","p":218},{"i":235,"t":"• locale: string = '' Inherited from​ PostsArchiveFetchStrategy.locale Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212","s":"locale","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#locale","p":218},{"i":237,"t":"• path: string = '' Inherited from​ PostsArchiveFetchStrategy.path Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210","s":"path","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#path","p":218},{"i":240,"t":"▸ buildEndpointURL(params): string Handles taxonomy filters and switch endpoint based on post type Parameters​ Name Type Description params Partial

The params to build the endpoint with Returns​ string Inherited from​ PostsArchiveFetchStrategy.buildEndpointURL Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289","s":"buildEndpointURL","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#buildendpointurl","p":218},{"i":242,"t":"▸ fetcher(url, params, options?): Promise> Before fetching posts, we need handle taxonomy and authors. If the headless plugin is not being used, then additional requests needs to be made to get authors and terms ids Parameters​ Name Type Description url string The URL to parse params Partial

The params to build the endpoint with options Partial FetchOptions Returns​ Promise> Inherited from​ PostsArchiveFetchStrategy.fetcher Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:393","s":"fetcher","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#fetcher","p":218},{"i":244,"t":"▸ filterData(data, options?): FetchResponse Filters the data returned from the API by excluding fields that are not needed in order to reduce payload size. Parameters​ Name Type Description data FetchResponse The data to filter options? FilterDataOptions Filter options Returns​ FetchResponse The filtered data Inherited from​ PostsArchiveFetchStrategy.filterData Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530","s":"filterData","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#filterdata","p":218},{"i":246,"t":"▸ get(params?): Promise> This is a simple wrapper to quickly fetch data from the API given a set of params","s":"get","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#get","p":218},{"i":248,"t":"import { PostsArchiveFetchStrategy } from '@headstartwp/core'; new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10}); Parameters​ Name Type Description params Partial

The endpoint params Returns​ Promise> Inherited from​ PostsArchiveFetchStrategy.get Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:404","s":"Usage","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#usage","p":218},{"i":250,"t":"▸ getAuthHeader(options?): string Parameters​ Name Type options Partial Returns​ string Inherited from​ PostsArchiveFetchStrategy.getAuthHeader Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:227","s":"getAuthHeader","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#getauthheader","p":218},{"i":252,"t":"▸ getCacheKey(params): Object Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites Parameters​ Name Type Description params Partial

The request params Returns​ Object The cache key object Name Type args Partial

& { sourceUrl: string } url string Inherited from​ PostsArchiveFetchStrategy.getCacheKey Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:369","s":"getCacheKey","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#getcachekey","p":218},{"i":254,"t":"▸ getDefaultEndpoint(): string A method that must be implemented by concrete implementations which returns the default endpoint for the strategy Returns​ string Inherited from​ PostsArchiveFetchStrategy.getDefaultEndpoint Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:214","s":"getDefaultEndpoint","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#getdefaultendpoint","p":218},{"i":256,"t":"▸ getDefaultParams(): Partial

Returns​ Partial

Inherited from​ PostsArchiveFetchStrategy.getDefaultParams Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218","s":"getDefaultParams","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#getdefaultparams","p":218},{"i":258,"t":"▸ getEndpoint(): string Returns the endpoint of the strategy. If no endpoint has been set at runtime, returns the default endpoint Returns​ string The current endpoint for the strategy Inherited from​ PostsArchiveFetchStrategy.getEndpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:160","s":"getEndpoint","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#getendpoint","p":218},{"i":260,"t":"▸ getParamsFromURL(path, nonUrlParams?): Partial

This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL It also takes into account the custom taxonomies specified in headless.config.js Parameters​ Name Type Description path string The URL path to extract params from nonUrlParams Partial

Returns​ Partial

Overrides​ PostsArchiveFetchStrategy.getParamsFromURL Defined in​ packages/core/src/data/strategies/AuthorArchiveFetchStrategy.ts:20","s":"getParamsFromURL","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#getparamsfromurl","p":218},{"i":262,"t":"▸ getQueriedObject(response, params): QueriedObject Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term) Parameters​ Name Type Description response FetchResponse The response from the API params Partial

The request params Returns​ QueriedObject Inherited from​ PostsArchiveFetchStrategy.getQueriedObject Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461","s":"getQueriedObject","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#getqueriedobject","p":218},{"i":264,"t":"▸ isMainQuery(path, nonUrlParams): boolean Checks if this is the main query for a page Parameters​ Name Type Description path string The page name nonUrlParams Partial

The non-url params Returns​ boolean Inherited from​ PostsArchiveFetchStrategy.isMainQuery Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:191","s":"isMainQuery","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#ismainquery","p":218},{"i":266,"t":"▸ normalizeForCache(data, params): NormalizedDataForCache Normalize data for cache. Parameters​ Name Type Description data FetchResponse The fetch response data params Partial

The request params Returns​ NormalizedDataForCache Inherited from​ PostsArchiveFetchStrategy.normalizeForCache Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:379","s":"normalizeForCache","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#normalizeforcache","p":218},{"i":268,"t":"▸ prepareResponse(response, params): FetchResponse Parameters​ Name Type response FetchResponse params Partial

Returns​ FetchResponse Inherited from​ PostsArchiveFetchStrategy.prepareResponse Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327","s":"prepareResponse","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#prepareresponse","p":218},{"i":270,"t":"▸ setBaseURL(url?): void Parameters​ Name Type Default value url undefined | string '' Returns​ void Inherited from​ PostsArchiveFetchStrategy.setBaseURL Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:150","s":"setBaseURL","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#setbaseurl","p":218},{"i":272,"t":"▸ setEndpoint(endpoint): void The strategy can switch endpoints at runtime if needed. E.g: The actual endpoint for a post depends on its post_type Parameters​ Name Type Description endpoint string The endpoint to fetch Returns​ void Inherited from​ PostsArchiveFetchStrategy.setEndpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:146","s":"setEndpoint","u":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","h":"#setendpoint","p":218},{"i":274,"t":"@headstartwp/core.NotFoundError","s":"Class: NotFoundError","u":"/docs/api/classes/headstartwp_core.NotFoundError/","h":"","p":273},{"i":276,"t":"Error ↳ NotFoundError","s":"Hierarchy","u":"/docs/api/classes/headstartwp_core.NotFoundError/","h":"#hierarchy","p":273},{"i":279,"t":"• new NotFoundError(message) Parameters​ Name Type message string Overrides​ Error.constructor Defined in​ packages/core/src/utils/errors.ts:4","s":"constructor","u":"/docs/api/classes/headstartwp_core.NotFoundError/","h":"#constructor","p":273},{"i":282,"t":"• Optional cause: unknown Inherited from​ Error.cause Defined in​ docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26","s":"cause","u":"/docs/api/classes/headstartwp_core.NotFoundError/","h":"#cause","p":273},{"i":284,"t":"• message: string Inherited from​ Error.message Defined in​ docs/node_modules/typescript/lib/lib.es5.d.ts:1054","s":"message","u":"/docs/api/classes/headstartwp_core.NotFoundError/","h":"#message","p":273},{"i":286,"t":"• name: string Inherited from​ Error.name Defined in​ docs/node_modules/typescript/lib/lib.es5.d.ts:1053","s":"name","u":"/docs/api/classes/headstartwp_core.NotFoundError/","h":"#name","p":273},{"i":288,"t":"• Optional stack: string Inherited from​ Error.stack Defined in​ docs/node_modules/typescript/lib/lib.es5.d.ts:1055 node_modules/@types/node/globals.d.ts:127","s":"stack","u":"/docs/api/classes/headstartwp_core.NotFoundError/","h":"#stack","p":273},{"i":290,"t":"▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any Type declaration​ ▸ (err, stackTraces): any Optional override for formatting stack traces See https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces Parameters​ Name Type err Error stackTraces CallSite[] Returns​ any Inherited from​ Error.prepareStackTrace Defined in​ node_modules/@types/node/globals.d.ts:140","s":"prepareStackTrace","u":"/docs/api/classes/headstartwp_core.NotFoundError/","h":"#preparestacktrace","p":273},{"i":292,"t":"▪ Static stackTraceLimit: number Inherited from​ Error.stackTraceLimit Defined in​ node_modules/@types/node/globals.d.ts:142","s":"stackTraceLimit","u":"/docs/api/classes/headstartwp_core.NotFoundError/","h":"#stacktracelimit","p":273},{"i":295,"t":"▸ Static captureStackTrace(targetObject, constructorOpt?): void Create .stack property on a target object Parameters​ Name Type targetObject Object constructorOpt? Function Returns​ void Inherited from​ Error.captureStackTrace Defined in​ node_modules/@types/node/globals.d.ts:133","s":"captureStackTrace","u":"/docs/api/classes/headstartwp_core.NotFoundError/","h":"#capturestacktrace","p":273},{"i":297,"t":"@headstartwp/core.FetchError","s":"Class: FetchError","u":"/docs/api/classes/headstartwp_core.FetchError/","h":"","p":296},{"i":299,"t":"Error ↳ FetchError","s":"Hierarchy","u":"/docs/api/classes/headstartwp_core.FetchError/","h":"#hierarchy","p":296},{"i":302,"t":"• new FetchError(message) Parameters​ Name Type message string Overrides​ Error.constructor Defined in​ packages/core/src/utils/errors.ts:11","s":"constructor","u":"/docs/api/classes/headstartwp_core.FetchError/","h":"#constructor","p":296},{"i":305,"t":"• Optional cause: unknown Inherited from​ Error.cause Defined in​ docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26","s":"cause","u":"/docs/api/classes/headstartwp_core.FetchError/","h":"#cause","p":296},{"i":307,"t":"• message: string Inherited from​ Error.message Defined in​ docs/node_modules/typescript/lib/lib.es5.d.ts:1054","s":"message","u":"/docs/api/classes/headstartwp_core.FetchError/","h":"#message","p":296},{"i":309,"t":"• name: string Inherited from​ Error.name Defined in​ docs/node_modules/typescript/lib/lib.es5.d.ts:1053","s":"name","u":"/docs/api/classes/headstartwp_core.FetchError/","h":"#name","p":296},{"i":311,"t":"• Optional stack: string Inherited from​ Error.stack Defined in​ docs/node_modules/typescript/lib/lib.es5.d.ts:1055 node_modules/@types/node/globals.d.ts:127","s":"stack","u":"/docs/api/classes/headstartwp_core.FetchError/","h":"#stack","p":296},{"i":313,"t":"▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any Type declaration​ ▸ (err, stackTraces): any Optional override for formatting stack traces See https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces Parameters​ Name Type err Error stackTraces CallSite[] Returns​ any Inherited from​ Error.prepareStackTrace Defined in​ node_modules/@types/node/globals.d.ts:140","s":"prepareStackTrace","u":"/docs/api/classes/headstartwp_core.FetchError/","h":"#preparestacktrace","p":296},{"i":315,"t":"▪ Static stackTraceLimit: number Inherited from​ Error.stackTraceLimit Defined in​ node_modules/@types/node/globals.d.ts:142","s":"stackTraceLimit","u":"/docs/api/classes/headstartwp_core.FetchError/","h":"#stacktracelimit","p":296},{"i":318,"t":"▸ Static captureStackTrace(targetObject, constructorOpt?): void Create .stack property on a target object Parameters​ Name Type targetObject Object constructorOpt? Function Returns​ void Inherited from​ Error.captureStackTrace Defined in​ node_modules/@types/node/globals.d.ts:133","s":"captureStackTrace","u":"/docs/api/classes/headstartwp_core.FetchError/","h":"#capturestacktrace","p":296},{"i":320,"t":"@headstartwp/core.ProcessingInstruction Processing instructions, including doc types.","s":"Class: ProcessingInstruction","u":"/docs/api/classes/headstartwp_core.ProcessingInstruction/","h":"","p":319},{"i":322,"t":"DataNode ↳ ProcessingInstruction","s":"Hierarchy","u":"/docs/api/classes/headstartwp_core.ProcessingInstruction/","h":"#hierarchy","p":319},{"i":325,"t":"• new ProcessingInstruction(name, data) Parameters​ Name Type name string data string Overrides​ DataNode.constructor Defined in​ node_modules/domhandler/lib/node.d.ts:113","s":"constructor","u":"/docs/api/classes/headstartwp_core.ProcessingInstruction/","h":"#constructor","p":319},{"i":328,"t":"• data: string Inherited from​ DataNode.data Defined in​ node_modules/domhandler/lib/node.d.ts:81","s":"data","u":"/docs/api/classes/headstartwp_core.ProcessingInstruction/","h":"#data","p":319},{"i":330,"t":"• endIndex: null | number The end index of the node. Requires withEndIndices on the handler to be `true. Inherited from​ DataNode.endIndex Defined in​ node_modules/domhandler/lib/node.d.ts:39","s":"endIndex","u":"/docs/api/classes/headstartwp_core.ProcessingInstruction/","h":"#endindex","p":319},{"i":332,"t":"• name: string Defined in​ node_modules/domhandler/lib/node.d.ts:111","s":"name","u":"/docs/api/classes/headstartwp_core.ProcessingInstruction/","h":"#name","p":319},{"i":334,"t":"• next: null | ChildNode Next sibling Inherited from​ DataNode.next Defined in​ node_modules/domhandler/lib/node.d.ts:35","s":"next","u":"/docs/api/classes/headstartwp_core.ProcessingInstruction/","h":"#next","p":319},{"i":336,"t":"• parent: null | ParentNode Parent of the node Inherited from​ DataNode.parent Defined in​ node_modules/domhandler/lib/node.d.ts:31","s":"parent","u":"/docs/api/classes/headstartwp_core.ProcessingInstruction/","h":"#parent","p":319},{"i":338,"t":"• prev: null | ChildNode Previous sibling Inherited from​ DataNode.prev Defined in​ node_modules/domhandler/lib/node.d.ts:33","s":"prev","u":"/docs/api/classes/headstartwp_core.ProcessingInstruction/","h":"#prev","p":319},{"i":340,"t":"• Optional sourceCodeLocation: null | SourceCodeLocation parse5 source code location info. Available if parsing with parse5 and location info is enabled. Inherited from​ DataNode.sourceCodeLocation Defined in​ node_modules/domhandler/lib/node.d.ts:45","s":"sourceCodeLocation","u":"/docs/api/classes/headstartwp_core.ProcessingInstruction/","h":"#sourcecodelocation","p":319},{"i":342,"t":"• startIndex: null | number The start index of the node. Requires withStartIndices on the handler to be `true. Inherited from​ DataNode.startIndex Defined in​ node_modules/domhandler/lib/node.d.ts:37","s":"startIndex","u":"/docs/api/classes/headstartwp_core.ProcessingInstruction/","h":"#startindex","p":319},{"i":344,"t":"• type: Directive Overrides​ DataNode.type Defined in​ node_modules/domhandler/lib/node.d.ts:112","s":"type","u":"/docs/api/classes/headstartwp_core.ProcessingInstruction/","h":"#type","p":319},{"i":346,"t":"• Optional x-name: string If this is a doctype, the document type name (parse5 only). Defined in​ node_modules/domhandler/lib/node.d.ts:116","s":"x-name","u":"/docs/api/classes/headstartwp_core.ProcessingInstruction/","h":"#x-name","p":319},{"i":348,"t":"• Optional x-publicId: string If this is a doctype, the document type public identifier (parse5 only). Defined in​ node_modules/domhandler/lib/node.d.ts:118","s":"x-publicId","u":"/docs/api/classes/headstartwp_core.ProcessingInstruction/","h":"#x-publicid","p":319},{"i":350,"t":"• Optional x-systemId: string If this is a doctype, the document type system identifier (parse5 only). Defined in​ node_modules/domhandler/lib/node.d.ts:120","s":"x-systemId","u":"/docs/api/classes/headstartwp_core.ProcessingInstruction/","h":"#x-systemid","p":319},{"i":353,"t":"• get nextSibling(): null | ChildNode Same as next. DOM spec-compatible alias. Returns​ null | ChildNode Inherited from​ DataNode.nextSibling Defined in​ node_modules/domhandler/lib/node.d.ts:67 • set nextSibling(next): void Parameters​ Name Type next null | ChildNode Returns​ void Inherited from​ DataNode.nextSibling Defined in​ node_modules/domhandler/lib/node.d.ts:68","s":"nextSibling","u":"/docs/api/classes/headstartwp_core.ProcessingInstruction/","h":"#nextsibling","p":319},{"i":355,"t":"• get nodeType(): 1 Returns​ 1 Overrides​ DataNode.nodeType Defined in​ node_modules/domhandler/lib/node.d.ts:114","s":"nodeType","u":"/docs/api/classes/headstartwp_core.ProcessingInstruction/","h":"#nodetype","p":319},{"i":357,"t":"• get nodeValue(): string Same as data. DOM spec-compatible alias. Returns​ string Inherited from​ DataNode.nodeValue Defined in​ node_modules/domhandler/lib/node.d.ts:90 • set nodeValue(data): void Parameters​ Name Type data string Returns​ void Inherited from​ DataNode.nodeValue Defined in​ node_modules/domhandler/lib/node.d.ts:91","s":"nodeValue","u":"/docs/api/classes/headstartwp_core.ProcessingInstruction/","h":"#nodevalue","p":319},{"i":359,"t":"• get parentNode(): null | ParentNode Same as parent. DOM spec-compatible alias. Returns​ null | ParentNode Inherited from​ DataNode.parentNode Defined in​ node_modules/domhandler/lib/node.d.ts:55 • set parentNode(parent): void Parameters​ Name Type parent null | ParentNode Returns​ void Inherited from​ DataNode.parentNode Defined in​ node_modules/domhandler/lib/node.d.ts:56","s":"parentNode","u":"/docs/api/classes/headstartwp_core.ProcessingInstruction/","h":"#parentnode","p":319},{"i":361,"t":"• get previousSibling(): null | ChildNode Same as prev. DOM spec-compatible alias. Returns​ null | ChildNode Inherited from​ DataNode.previousSibling Defined in​ node_modules/domhandler/lib/node.d.ts:61 • set previousSibling(prev): void Parameters​ Name Type prev null | ChildNode Returns​ void Inherited from​ DataNode.previousSibling Defined in​ node_modules/domhandler/lib/node.d.ts:62","s":"previousSibling","u":"/docs/api/classes/headstartwp_core.ProcessingInstruction/","h":"#previoussibling","p":319},{"i":364,"t":"▸ cloneNode(this, recursive?): T Clone this node, and optionally its children. Type parameters​ Name Type T extends Node Parameters​ Name Type Description this T - recursive? boolean Clone child nodes as well. Returns​ T A clone of the node. Inherited from​ DataNode.cloneNode Defined in​ node_modules/domhandler/lib/node.d.ts:75","s":"cloneNode","u":"/docs/api/classes/headstartwp_core.ProcessingInstruction/","h":"#clonenode","p":319},{"i":366,"t":"@headstartwp/core.PostsArchiveFetchStrategy The PostsArchiveFetchStrategy is used to fetch a collection of posts from any post type. Note that custom post types and custom taxonomies should be defined in headless.config.js This strategy supports extracting endpoint params from url E.g: /category/cat-name/page/2 maps to { category: 'cat-name', page: 2 } /page/2/ maps to { page: 2 } /genre/genre-name/page/2 maps to { genre: 'genre-name', page: 2 } if a genre taxonomy is defined in headless.config.js See getParamsFromURL to learn about url param mapping","s":"Class: PostsArchiveFetchStrategy","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"","p":365},{"i":368,"t":"Name Type T extends PostEntity = PostEntity P extends PostsArchiveParams = PostsArchiveParams","s":"Type parameters","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#type-parameters","p":365},{"i":370,"t":"AbstractFetchStrategy ↳ PostsArchiveFetchStrategy ↳↳ SearchFetchStrategy ↳↳ AuthorArchiveFetchStrategy","s":"Hierarchy","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#hierarchy","p":365},{"i":373,"t":"• new PostsArchiveFetchStrategy(baseURL?, defaultParams?) The strategy constructor Type parameters​ Name Type T extends PostEntity = PostEntity P extends PostsArchiveParams = PostsArchiveParams Parameters​ Name Type Description baseURL? string The base URL of the API defaultParams? Partial

(optional) list of default params Inherited from​ AbstractFetchStrategy.constructor Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:129","s":"constructor","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#constructor","p":365},{"i":376,"t":"• baseURL: string = '' The base URL where the API is located Inherited from​ AbstractFetchStrategy.baseURL Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:115","s":"baseURL","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#baseurl","p":365},{"i":378,"t":"• defaultParams: Partial

= {} The Default Params Inherited from​ AbstractFetchStrategy.defaultParams Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:105","s":"defaultParams","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#defaultparams","p":365},{"i":380,"t":"• endpoint: string = '' Holds the current endpoint for the strategy Inherited from​ AbstractFetchStrategy.endpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:110","s":"endpoint","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#endpoint","p":365},{"i":382,"t":"• locale: string = '' Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212","s":"locale","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#locale","p":365},{"i":384,"t":"• path: string = '' Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210","s":"path","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#path","p":365},{"i":387,"t":"▸ buildEndpointURL(params): string Handles taxonomy filters and switch endpoint based on post type Parameters​ Name Type Description params Partial

The params to build the endpoint with Returns​ string Overrides​ AbstractFetchStrategy.buildEndpointURL Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289","s":"buildEndpointURL","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#buildendpointurl","p":365},{"i":389,"t":"▸ fetcher(url, params, options?): Promise> Before fetching posts, we need handle taxonomy and authors. If the headless plugin is not being used, then additional requests needs to be made to get authors and terms ids Parameters​ Name Type Description url string The URL to parse params Partial

The params to build the endpoint with options Partial FetchOptions Returns​ Promise> Overrides​ AbstractFetchStrategy.fetcher Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:393","s":"fetcher","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#fetcher","p":365},{"i":391,"t":"▸ filterData(data, options?): FetchResponse Filters the data returned from the API by excluding fields that are not needed in order to reduce payload size. Parameters​ Name Type Description data FetchResponse The data to filter options? FilterDataOptions Filter options Returns​ FetchResponse The filtered data Overrides​ AbstractFetchStrategy.filterData Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530","s":"filterData","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#filterdata","p":365},{"i":393,"t":"▸ get(params?): Promise> This is a simple wrapper to quickly fetch data from the API given a set of params","s":"get","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#get","p":365},{"i":395,"t":"import { PostsArchiveFetchStrategy } from '@headstartwp/core'; new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10}); Parameters​ Name Type Description params Partial

The endpoint params Returns​ Promise> Inherited from​ AbstractFetchStrategy.get Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:404","s":"Usage","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#usage","p":365},{"i":397,"t":"▸ getAuthHeader(options?): string Parameters​ Name Type options Partial Returns​ string Inherited from​ AbstractFetchStrategy.getAuthHeader Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:227","s":"getAuthHeader","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#getauthheader","p":365},{"i":399,"t":"▸ getCacheKey(params): Object Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites Parameters​ Name Type Description params Partial

The request params Returns​ Object The cache key object Name Type args Partial

& { sourceUrl: string } url string Inherited from​ AbstractFetchStrategy.getCacheKey Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:369","s":"getCacheKey","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#getcachekey","p":365},{"i":401,"t":"▸ getDefaultEndpoint(): string A method that must be implemented by concrete implementations which returns the default endpoint for the strategy Returns​ string Overrides​ AbstractFetchStrategy.getDefaultEndpoint Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:214","s":"getDefaultEndpoint","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#getdefaultendpoint","p":365},{"i":403,"t":"▸ getDefaultParams(): Partial

Returns​ Partial

Overrides​ AbstractFetchStrategy.getDefaultParams Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218","s":"getDefaultParams","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#getdefaultparams","p":365},{"i":405,"t":"▸ getEndpoint(): string Returns the endpoint of the strategy. If no endpoint has been set at runtime, returns the default endpoint Returns​ string The current endpoint for the strategy Inherited from​ AbstractFetchStrategy.getEndpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:160","s":"getEndpoint","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#getendpoint","p":365},{"i":407,"t":"▸ getParamsFromURL(path, params?): Partial

This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL It also takes into account the custom taxonomies specified in headless.config.js Parameters​ Name Type Description path string The URL path to extract params from params Partial

Returns​ Partial

Overrides​ AbstractFetchStrategy.getParamsFromURL Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:230","s":"getParamsFromURL","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#getparamsfromurl","p":365},{"i":409,"t":"▸ getQueriedObject(response, params): QueriedObject Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term) Parameters​ Name Type Description response FetchResponse The response from the API params Partial

The request params Returns​ QueriedObject Overrides​ AbstractFetchStrategy.getQueriedObject Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461","s":"getQueriedObject","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#getqueriedobject","p":365},{"i":411,"t":"▸ isMainQuery(path, nonUrlParams): boolean Checks if this is the main query for a page Parameters​ Name Type Description path string The page name nonUrlParams Partial

The non-url params Returns​ boolean Inherited from​ AbstractFetchStrategy.isMainQuery Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:191","s":"isMainQuery","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#ismainquery","p":365},{"i":413,"t":"▸ normalizeForCache(data, params): NormalizedDataForCache Normalize data for cache. Parameters​ Name Type Description data FetchResponse The fetch response data params Partial

The request params Returns​ NormalizedDataForCache Inherited from​ AbstractFetchStrategy.normalizeForCache Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:379","s":"normalizeForCache","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#normalizeforcache","p":365},{"i":415,"t":"▸ prepareResponse(response, params): FetchResponse Parameters​ Name Type response FetchResponse params Partial

Returns​ FetchResponse Overrides​ AbstractFetchStrategy.prepareResponse Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327","s":"prepareResponse","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#prepareresponse","p":365},{"i":417,"t":"▸ setBaseURL(url?): void Parameters​ Name Type Default value url undefined | string '' Returns​ void Inherited from​ AbstractFetchStrategy.setBaseURL Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:150","s":"setBaseURL","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#setbaseurl","p":365},{"i":419,"t":"▸ setEndpoint(endpoint): void The strategy can switch endpoints at runtime if needed. E.g: The actual endpoint for a post depends on its post_type Parameters​ Name Type Description endpoint string The endpoint to fetch Returns​ void Inherited from​ AbstractFetchStrategy.setEndpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:146","s":"setEndpoint","u":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","h":"#setendpoint","p":365},{"i":421,"t":"@headstartwp/core.PostOrPostsFetchStrategy This fetch strategy does not support extracting url params from the url","s":"Class: PostOrPostsFetchStrategy","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"","p":420},{"i":423,"t":"Name Type T extends PostEntity = PostEntity P extends PostOrPostsParams = PostOrPostsParams R extends PostOrPostsFetchStrategyResult = PostOrPostsFetchStrategyResult","s":"Type parameters","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#type-parameters","p":420},{"i":425,"t":"AbstractFetchStrategy ↳ PostOrPostsFetchStrategy","s":"Hierarchy","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#hierarchy","p":420},{"i":428,"t":"• new PostOrPostsFetchStrategy(baseURL?, defaultParams?) The strategy constructor Type parameters​ Name Type T extends PostEntity = PostEntity P extends PostOrPostsParams = PostOrPostsParams R extends PostOrPostsFetchStrategyResult = PostOrPostsFetchStrategyResult Parameters​ Name Type Description baseURL? string The base URL of the API defaultParams? Partial

(optional) list of default params Inherited from​ AbstractFetchStrategy.constructor Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:129","s":"constructor","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#constructor","p":420},{"i":431,"t":"• baseURL: string = '' The base URL where the API is located Inherited from​ AbstractFetchStrategy.baseURL Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:115","s":"baseURL","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#baseurl","p":420},{"i":433,"t":"• defaultParams: Partial

= {} The Default Params Inherited from​ AbstractFetchStrategy.defaultParams Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:105","s":"defaultParams","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#defaultparams","p":420},{"i":435,"t":"• endpoint: string = '' Holds the current endpoint for the strategy Inherited from​ AbstractFetchStrategy.endpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:110","s":"endpoint","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#endpoint","p":420},{"i":437,"t":"• postStrategy: SinglePostFetchStrategy Defined in​ packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:60","s":"postStrategy","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#poststrategy","p":420},{"i":439,"t":"• postsStrategy: PostsArchiveFetchStrategy Defined in​ packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:62","s":"postsStrategy","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#postsstrategy","p":420},{"i":441,"t":"• urlParams: Partial

= {} Defined in​ packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:58","s":"urlParams","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#urlparams","p":420},{"i":444,"t":"▸ buildEndpointURL(params): string Builds the final endpoint URL based on the passed parameters Parameters​ Name Type Description params Partial

The params to add to the request Returns​ string The endpoint URL. Inherited from​ AbstractFetchStrategy.buildEndpointURL Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:206","s":"buildEndpointURL","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#buildendpointurl","p":420},{"i":446,"t":"▸ fetchArchive(url, params, options?): Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: R }> Parameters​ Name Type url string params PostsArchiveParams options? Partial Returns​ Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: R }> Defined in​ packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:145","s":"fetchArchive","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#fetcharchive","p":420},{"i":448,"t":"▸ fetchSingle(url, params, options?): Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: R }> Parameters​ Name Type url string params PostParams options? Partial Returns​ Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: R }> Defined in​ packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:132","s":"fetchSingle","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#fetchsingle","p":420},{"i":450,"t":"▸ fetcher(url, params, options?): Promise> The default fetcher function The default fetcher function handles authentication headers and errors from the API. A custom strategy can override this function to run additional logic before or after the fetch call Parameters​ Name Type Description url string The URL to fetch params Partial

The request params options? Partial The fetcher options Returns​ Promise> Overrides​ AbstractFetchStrategy.fetcher Defined in​ packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:158","s":"fetcher","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#fetcher","p":420},{"i":452,"t":"▸ filterData(data, filterOptions?): FetchResponse Filters the data returned from the API by excluding fields that are not needed in order to reduce payload size. Parameters​ Name Type Description data FetchResponse The data to filter filterOptions? FilterDataOptions Filter options Returns​ FetchResponse The filtered data Inherited from​ AbstractFetchStrategy.filterData Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:339","s":"filterData","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#filterdata","p":420},{"i":454,"t":"▸ get(params?): Promise> This is a simple wrapper to quickly fetch data from the API given a set of params","s":"get","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#get","p":420},{"i":456,"t":"import { PostsArchiveFetchStrategy } from '@headstartwp/core'; new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10}); Parameters​ Name Type Description params Partial

The endpoint params Returns​ Promise> Inherited from​ AbstractFetchStrategy.get Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:404","s":"Usage","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#usage","p":420},{"i":458,"t":"▸ getAuthHeader(options?): string Parameters​ Name Type options Partial Returns​ string Inherited from​ AbstractFetchStrategy.getAuthHeader Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:227","s":"getAuthHeader","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#getauthheader","p":420},{"i":460,"t":"▸ getCacheKey(params): Object Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites Parameters​ Name Type Description params Partial

The request params Returns​ Object The cache key object Name Type args Partial

& { sourceUrl: string } url string Inherited from​ AbstractFetchStrategy.getCacheKey Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:369","s":"getCacheKey","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#getcachekey","p":420},{"i":462,"t":"▸ getDefaultEndpoint(): string A method that must be implemented by concrete implementations which returns the default endpoint for the strategy Returns​ string Overrides​ AbstractFetchStrategy.getDefaultEndpoint Defined in​ packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:64","s":"getDefaultEndpoint","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#getdefaultendpoint","p":420},{"i":464,"t":"▸ getDefaultParams(): Partial

Returns​ Partial

Inherited from​ AbstractFetchStrategy.getDefaultParams Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:168","s":"getDefaultParams","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#getdefaultparams","p":420},{"i":466,"t":"▸ getEndpoint(): string Returns the endpoint of the strategy. If no endpoint has been set at runtime, returns the default endpoint Returns​ string The current endpoint for the strategy Inherited from​ AbstractFetchStrategy.getEndpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:160","s":"getEndpoint","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#getendpoint","p":420},{"i":468,"t":"▸ getParamsFromURL(path, params?): Partial

Returns the supported params from the URL if present. These params are passed to buildEndpointURL. If the strategy does not support mapping url params to endpoint params, it should return an empty object. Parameters​ Name Type Description path string The Path name params Partial

The non-url params Returns​ Partial

params extracted from the URL Overrides​ AbstractFetchStrategy.getParamsFromURL Defined in​ packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:68","s":"getParamsFromURL","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#getparamsfromurl","p":420},{"i":470,"t":"▸ getQueriedObject(response, params): Object Parameters​ Name Type response FetchResponse params Partial

Returns​ Object Inherited from​ AbstractFetchStrategy.getQueriedObject Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:327","s":"getQueriedObject","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#getqueriedobject","p":420},{"i":472,"t":"▸ isMainQuery(path, nonUrlParams): boolean Checks if this is the main query for a page Parameters​ Name Type Description path string The page name nonUrlParams Partial

The non-url params Returns​ boolean Inherited from​ AbstractFetchStrategy.isMainQuery Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:191","s":"isMainQuery","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#ismainquery","p":420},{"i":474,"t":"▸ normalizeForCache(data, params): NormalizedDataForCache Normalize data for cache. Parameters​ Name Type Description data FetchResponse The fetch response data params Partial

The request params Returns​ NormalizedDataForCache Overrides​ AbstractFetchStrategy.normalizeForCache Defined in​ packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:77","s":"normalizeForCache","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#normalizeforcache","p":420},{"i":476,"t":"▸ prepareResponse(response, params): FetchResponse Parameters​ Name Type response FetchResponse params Partial

Returns​ FetchResponse Inherited from​ AbstractFetchStrategy.prepareResponse Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:219","s":"prepareResponse","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#prepareresponse","p":420},{"i":478,"t":"▸ setBaseURL(url?): void Parameters​ Name Type Default value url undefined | string '' Returns​ void Inherited from​ AbstractFetchStrategy.setBaseURL Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:150","s":"setBaseURL","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#setbaseurl","p":420},{"i":480,"t":"▸ setEndpoint(endpoint): void The strategy can switch endpoints at runtime if needed. E.g: The actual endpoint for a post depends on its post_type Parameters​ Name Type Description endpoint string The endpoint to fetch Returns​ void Inherited from​ AbstractFetchStrategy.setEndpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:146","s":"setEndpoint","u":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","h":"#setendpoint","p":420},{"i":482,"t":"@headstartwp/core.SearchFetchStrategy The SearchFetchStrategy extends the PostsArchiveFetchStrategy and does not make use of the search endpoint. Instead it uses the specified postType endpoint. This strategy supports extracting endpoint params from url E.g: /page/2/ maps to { page: 2 } /searched-term/page/2 maps to { search: 'searched-term', page: 2 }","s":"Class: SearchFetchStrategy","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"","p":481},{"i":484,"t":"Name Type T extends PostEntity = PostEntity P extends PostsArchiveParams = PostsArchiveParams","s":"Type parameters","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#type-parameters","p":481},{"i":486,"t":"PostsArchiveFetchStrategy ↳ SearchFetchStrategy","s":"Hierarchy","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#hierarchy","p":481},{"i":489,"t":"• new SearchFetchStrategy(baseURL?, defaultParams?) The strategy constructor Type parameters​ Name Type T extends PostEntity = PostEntity P extends PostsArchiveParams = PostsArchiveParams Parameters​ Name Type Description baseURL? string The base URL of the API defaultParams? Partial

(optional) list of default params Inherited from​ PostsArchiveFetchStrategy.constructor Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:129","s":"constructor","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#constructor","p":481},{"i":492,"t":"• baseURL: string = '' The base URL where the API is located Inherited from​ PostsArchiveFetchStrategy.baseURL Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:115","s":"baseURL","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#baseurl","p":481},{"i":494,"t":"• defaultParams: Partial

= {} The Default Params Inherited from​ PostsArchiveFetchStrategy.defaultParams Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:105","s":"defaultParams","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#defaultparams","p":481},{"i":496,"t":"• endpoint: string = '' Holds the current endpoint for the strategy Inherited from​ PostsArchiveFetchStrategy.endpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:110","s":"endpoint","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#endpoint","p":481},{"i":498,"t":"• locale: string = '' Inherited from​ PostsArchiveFetchStrategy.locale Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212","s":"locale","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#locale","p":481},{"i":500,"t":"• path: string = '' Inherited from​ PostsArchiveFetchStrategy.path Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210","s":"path","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#path","p":481},{"i":503,"t":"▸ buildEndpointURL(params): string Handles taxonomy filters and switch endpoint based on post type Parameters​ Name Type Description params Partial

The params to build the endpoint with Returns​ string Inherited from​ PostsArchiveFetchStrategy.buildEndpointURL Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289","s":"buildEndpointURL","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#buildendpointurl","p":481},{"i":505,"t":"▸ fetcher(url, params, options?): Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: T[] }> The fetcher function is overridden to disable throwing if not found If a search request returns not found we do not want to redirect to a 404 page, instead the user should be informed that no posts were found Parameters​ Name Type Description url string The url to parse params Partial

The params to build the endpoint with options Partial FetchOptions Returns​ Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: T[] }> Overrides​ PostsArchiveFetchStrategy.fetcher Defined in​ packages/core/src/data/strategies/SearchFetchStrategy.ts:46","s":"fetcher","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#fetcher","p":481},{"i":507,"t":"▸ filterData(data, options?): FetchResponse Filters the data returned from the API by excluding fields that are not needed in order to reduce payload size. Parameters​ Name Type Description data FetchResponse The data to filter options? FilterDataOptions Filter options Returns​ FetchResponse The filtered data Inherited from​ PostsArchiveFetchStrategy.filterData Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530","s":"filterData","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#filterdata","p":481},{"i":509,"t":"▸ get(params?): Promise> This is a simple wrapper to quickly fetch data from the API given a set of params","s":"get","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#get","p":481},{"i":511,"t":"import { PostsArchiveFetchStrategy } from '@headstartwp/core'; new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10}); Parameters​ Name Type Description params Partial

The endpoint params Returns​ Promise> Inherited from​ PostsArchiveFetchStrategy.get Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:404","s":"Usage","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#usage","p":481},{"i":513,"t":"▸ getAuthHeader(options?): string Parameters​ Name Type options Partial Returns​ string Inherited from​ PostsArchiveFetchStrategy.getAuthHeader Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:227","s":"getAuthHeader","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#getauthheader","p":481},{"i":515,"t":"▸ getCacheKey(params): Object Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites Parameters​ Name Type Description params Partial

The request params Returns​ Object The cache key object Name Type args Partial

& { sourceUrl: string } url string Inherited from​ PostsArchiveFetchStrategy.getCacheKey Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:369","s":"getCacheKey","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#getcachekey","p":481},{"i":517,"t":"▸ getDefaultEndpoint(): string A method that must be implemented by concrete implementations which returns the default endpoint for the strategy Returns​ string Overrides​ PostsArchiveFetchStrategy.getDefaultEndpoint Defined in​ packages/core/src/data/strategies/SearchFetchStrategy.ts:24","s":"getDefaultEndpoint","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#getdefaultendpoint","p":481},{"i":519,"t":"▸ getDefaultParams(): Partial

Returns​ Partial

Inherited from​ PostsArchiveFetchStrategy.getDefaultParams Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218","s":"getDefaultParams","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#getdefaultparams","p":481},{"i":521,"t":"▸ getEndpoint(): string Returns the endpoint of the strategy. If no endpoint has been set at runtime, returns the default endpoint Returns​ string The current endpoint for the strategy Inherited from​ PostsArchiveFetchStrategy.getEndpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:160","s":"getEndpoint","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#getendpoint","p":481},{"i":523,"t":"▸ getParamsFromURL(path, nonUrlParams?): Partial

This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL It also takes into account the custom taxonomies specified in headless.config.js Parameters​ Name Type Description path string The URL path to extract params from nonUrlParams Partial

Returns​ Partial

Overrides​ PostsArchiveFetchStrategy.getParamsFromURL Defined in​ packages/core/src/data/strategies/SearchFetchStrategy.ts:28","s":"getParamsFromURL","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#getparamsfromurl","p":481},{"i":525,"t":"▸ getQueriedObject(response, params): QueriedObject Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term) Parameters​ Name Type Description response FetchResponse The response from the API params Partial

The request params Returns​ QueriedObject Inherited from​ PostsArchiveFetchStrategy.getQueriedObject Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461","s":"getQueriedObject","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#getqueriedobject","p":481},{"i":527,"t":"▸ isMainQuery(path, nonUrlParams): boolean Checks if this is the main query for a page Parameters​ Name Type Description path string The page name nonUrlParams Partial

The non-url params Returns​ boolean Inherited from​ PostsArchiveFetchStrategy.isMainQuery Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:191","s":"isMainQuery","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#ismainquery","p":481},{"i":529,"t":"▸ normalizeForCache(data, params): NormalizedDataForCache Normalize data for cache. Parameters​ Name Type Description data FetchResponse The fetch response data params Partial

The request params Returns​ NormalizedDataForCache Inherited from​ PostsArchiveFetchStrategy.normalizeForCache Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:379","s":"normalizeForCache","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#normalizeforcache","p":481},{"i":531,"t":"▸ prepareResponse(response, params): FetchResponse Parameters​ Name Type response FetchResponse params Partial

Returns​ FetchResponse Inherited from​ PostsArchiveFetchStrategy.prepareResponse Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327","s":"prepareResponse","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#prepareresponse","p":481},{"i":533,"t":"▸ setBaseURL(url?): void Parameters​ Name Type Default value url undefined | string '' Returns​ void Inherited from​ PostsArchiveFetchStrategy.setBaseURL Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:150","s":"setBaseURL","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#setbaseurl","p":481},{"i":535,"t":"▸ setEndpoint(endpoint): void The strategy can switch endpoints at runtime if needed. E.g: The actual endpoint for a post depends on its post_type Parameters​ Name Type Description endpoint string The endpoint to fetch Returns​ void Inherited from​ PostsArchiveFetchStrategy.setEndpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:146","s":"setEndpoint","u":"/docs/api/classes/headstartwp_core.SearchFetchStrategy/","h":"#setendpoint","p":481},{"i":537,"t":"@headstartwp/core.Text Text within the document.","s":"Class: Text","u":"/docs/api/classes/headstartwp_core.Text/","h":"","p":536},{"i":539,"t":"DataNode ↳ Text","s":"Hierarchy","u":"/docs/api/classes/headstartwp_core.Text/","h":"#hierarchy","p":536},{"i":542,"t":"• new Text(data) Parameters​ Name Type Description data string The content of the data node Inherited from​ DataNode.constructor Defined in​ node_modules/domhandler/lib/node.d.ts:85","s":"constructor","u":"/docs/api/classes/headstartwp_core.Text/","h":"#constructor","p":536},{"i":545,"t":"• data: string Inherited from​ DataNode.data Defined in​ node_modules/domhandler/lib/node.d.ts:81","s":"data","u":"/docs/api/classes/headstartwp_core.Text/","h":"#data","p":536},{"i":547,"t":"• endIndex: null | number The end index of the node. Requires withEndIndices on the handler to be `true. Inherited from​ DataNode.endIndex Defined in​ node_modules/domhandler/lib/node.d.ts:39","s":"endIndex","u":"/docs/api/classes/headstartwp_core.Text/","h":"#endindex","p":536},{"i":549,"t":"• next: null | ChildNode Next sibling Inherited from​ DataNode.next Defined in​ node_modules/domhandler/lib/node.d.ts:35","s":"next","u":"/docs/api/classes/headstartwp_core.Text/","h":"#next","p":536},{"i":551,"t":"• parent: null | ParentNode Parent of the node Inherited from​ DataNode.parent Defined in​ node_modules/domhandler/lib/node.d.ts:31","s":"parent","u":"/docs/api/classes/headstartwp_core.Text/","h":"#parent","p":536},{"i":553,"t":"• prev: null | ChildNode Previous sibling Inherited from​ DataNode.prev Defined in​ node_modules/domhandler/lib/node.d.ts:33","s":"prev","u":"/docs/api/classes/headstartwp_core.Text/","h":"#prev","p":536},{"i":555,"t":"• Optional sourceCodeLocation: null | SourceCodeLocation parse5 source code location info. Available if parsing with parse5 and location info is enabled. Inherited from​ DataNode.sourceCodeLocation Defined in​ node_modules/domhandler/lib/node.d.ts:45","s":"sourceCodeLocation","u":"/docs/api/classes/headstartwp_core.Text/","h":"#sourcecodelocation","p":536},{"i":557,"t":"• startIndex: null | number The start index of the node. Requires withStartIndices on the handler to be `true. Inherited from​ DataNode.startIndex Defined in​ node_modules/domhandler/lib/node.d.ts:37","s":"startIndex","u":"/docs/api/classes/headstartwp_core.Text/","h":"#startindex","p":536},{"i":559,"t":"• type: Text Overrides​ DataNode.type Defined in​ node_modules/domhandler/lib/node.d.ts:97","s":"type","u":"/docs/api/classes/headstartwp_core.Text/","h":"#type","p":536},{"i":562,"t":"• get nextSibling(): null | ChildNode Same as next. DOM spec-compatible alias. Returns​ null | ChildNode Inherited from​ DataNode.nextSibling Defined in​ node_modules/domhandler/lib/node.d.ts:67 • set nextSibling(next): void Parameters​ Name Type next null | ChildNode Returns​ void Inherited from​ DataNode.nextSibling Defined in​ node_modules/domhandler/lib/node.d.ts:68","s":"nextSibling","u":"/docs/api/classes/headstartwp_core.Text/","h":"#nextsibling","p":536},{"i":564,"t":"• get nodeType(): 3 Returns​ 3 Overrides​ DataNode.nodeType Defined in​ node_modules/domhandler/lib/node.d.ts:98","s":"nodeType","u":"/docs/api/classes/headstartwp_core.Text/","h":"#nodetype","p":536},{"i":566,"t":"• get nodeValue(): string Same as data. DOM spec-compatible alias. Returns​ string Inherited from​ DataNode.nodeValue Defined in​ node_modules/domhandler/lib/node.d.ts:90 • set nodeValue(data): void Parameters​ Name Type data string Returns​ void Inherited from​ DataNode.nodeValue Defined in​ node_modules/domhandler/lib/node.d.ts:91","s":"nodeValue","u":"/docs/api/classes/headstartwp_core.Text/","h":"#nodevalue","p":536},{"i":568,"t":"• get parentNode(): null | ParentNode Same as parent. DOM spec-compatible alias. Returns​ null | ParentNode Inherited from​ DataNode.parentNode Defined in​ node_modules/domhandler/lib/node.d.ts:55 • set parentNode(parent): void Parameters​ Name Type parent null | ParentNode Returns​ void Inherited from​ DataNode.parentNode Defined in​ node_modules/domhandler/lib/node.d.ts:56","s":"parentNode","u":"/docs/api/classes/headstartwp_core.Text/","h":"#parentnode","p":536},{"i":570,"t":"• get previousSibling(): null | ChildNode Same as prev. DOM spec-compatible alias. Returns​ null | ChildNode Inherited from​ DataNode.previousSibling Defined in​ node_modules/domhandler/lib/node.d.ts:61 • set previousSibling(prev): void Parameters​ Name Type prev null | ChildNode Returns​ void Inherited from​ DataNode.previousSibling Defined in​ node_modules/domhandler/lib/node.d.ts:62","s":"previousSibling","u":"/docs/api/classes/headstartwp_core.Text/","h":"#previoussibling","p":536},{"i":573,"t":"▸ cloneNode(this, recursive?): T Clone this node, and optionally its children. Type parameters​ Name Type T extends Node Parameters​ Name Type Description this T - recursive? boolean Clone child nodes as well. Returns​ T A clone of the node. Inherited from​ DataNode.cloneNode Defined in​ node_modules/domhandler/lib/node.d.ts:75","s":"cloneNode","u":"/docs/api/classes/headstartwp_core.Text/","h":"#clonenode","p":536},{"i":575,"t":"@headstartwp/core.SinglePostFetchStrategy The SinglePostFetchStrategy is used to fetch a single post entity from any post type. Note that custom post types should be defined in headless.config.js This strategy supports extracting endpoint params from url E.g: /post-name maps to { slug: 'post-name'} /2021/10/20/post-name maps to { year: 2021, month: 10, day: 20, slug: 'post-name } /2021/ maps to { year: 2021, slug: 'post-name' } See getParamsFromURL to learn about url param mapping","s":"Class: SinglePostFetchStrategy","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"","p":574},{"i":577,"t":"Name Type T extends PostEntity = PostEntity P extends PostParams = PostParams","s":"Type parameters","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#type-parameters","p":574},{"i":579,"t":"AbstractFetchStrategy ↳ SinglePostFetchStrategy","s":"Hierarchy","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#hierarchy","p":574},{"i":582,"t":"• new SinglePostFetchStrategy(baseURL?, defaultParams?) The strategy constructor Type parameters​ Name Type T extends PostEntity = PostEntity P extends PostParams = PostParams Parameters​ Name Type Description baseURL? string The base URL of the API defaultParams? Partial

(optional) list of default params Inherited from​ AbstractFetchStrategy.constructor Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:129","s":"constructor","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#constructor","p":574},{"i":585,"t":"• baseURL: string = '' The base URL where the API is located Inherited from​ AbstractFetchStrategy.baseURL Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:115","s":"baseURL","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#baseurl","p":574},{"i":587,"t":"• defaultParams: Partial

= {} The Default Params Inherited from​ AbstractFetchStrategy.defaultParams Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:105","s":"defaultParams","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#defaultparams","p":574},{"i":589,"t":"• endpoint: string = '' Holds the current endpoint for the strategy Inherited from​ AbstractFetchStrategy.endpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:110","s":"endpoint","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#endpoint","p":574},{"i":591,"t":"• locale: string = '' Defined in​ packages/core/src/data/strategies/SinglePostFetchStrategy.ts:89","s":"locale","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#locale","p":574},{"i":593,"t":"• path: string = '' Defined in​ packages/core/src/data/strategies/SinglePostFetchStrategy.ts:87","s":"path","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#path","p":574},{"i":595,"t":"• postType: string = 'post' Defined in​ packages/core/src/data/strategies/SinglePostFetchStrategy.ts:83","s":"postType","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#posttype","p":574},{"i":597,"t":"• Optional revision: PostEntity Defined in​ packages/core/src/data/strategies/SinglePostFetchStrategy.ts:85","s":"revision","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#revision","p":574},{"i":599,"t":"• shouldCheckCurrentPathAgainstPostLink: boolean = true Defined in​ packages/core/src/data/strategies/SinglePostFetchStrategy.ts:91","s":"shouldCheckCurrentPathAgainstPostLink","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#shouldcheckcurrentpathagainstpostlink","p":574},{"i":602,"t":"▸ buildEndpointURL(params): string Handlers post types, revisions and fetching by id Parameters​ Name Type Description params P The params to build the endpoint url Returns​ string Overrides​ AbstractFetchStrategy.buildEndpointURL Defined in​ packages/core/src/data/strategies/SinglePostFetchStrategy.ts:127","s":"buildEndpointURL","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#buildendpointurl","p":574},{"i":604,"t":"▸ fetcher(url, params, options?): Promise> Handles fetching by multiple post types, authToken and revisions Parameters​ Name Type Description url string The url to fetch params P The params to build the endpoint url options Partial FetchOptions Returns​ Promise> Overrides​ AbstractFetchStrategy.fetcher Defined in​ packages/core/src/data/strategies/SinglePostFetchStrategy.ts:275","s":"fetcher","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#fetcher","p":574},{"i":606,"t":"▸ filterData(data, filterOptions?): any Filters the data returned from the API by excluding fields that are not needed in order to reduce payload size. Parameters​ Name Type Description data FetchResponse The data to filter filterOptions? FilterDataOptions Filter options Returns​ any The filtered data Overrides​ AbstractFetchStrategy.filterData Defined in​ packages/core/src/data/strategies/SinglePostFetchStrategy.ts:338","s":"filterData","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#filterdata","p":574},{"i":608,"t":"▸ get(params?): Promise> This is a simple wrapper to quickly fetch data from the API given a set of params","s":"get","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#get","p":574},{"i":610,"t":"import { PostsArchiveFetchStrategy } from '@headstartwp/core'; new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10}); Parameters​ Name Type Description params Partial

The endpoint params Returns​ Promise> Inherited from​ AbstractFetchStrategy.get Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:404","s":"Usage","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#usage","p":574},{"i":612,"t":"▸ getAuthHeader(options?): string Parameters​ Name Type options Partial Returns​ string Inherited from​ AbstractFetchStrategy.getAuthHeader Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:227","s":"getAuthHeader","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#getauthheader","p":574},{"i":614,"t":"▸ getCacheKey(params): Object Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites Parameters​ Name Type Description params Partial

The request params Returns​ Object The cache key object Name Type args Partial

& { sourceUrl: string } url string Inherited from​ AbstractFetchStrategy.getCacheKey Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:369","s":"getCacheKey","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#getcachekey","p":574},{"i":616,"t":"▸ getDefaultEndpoint(): string A method that must be implemented by concrete implementations which returns the default endpoint for the strategy Returns​ string Overrides​ AbstractFetchStrategy.getDefaultEndpoint Defined in​ packages/core/src/data/strategies/SinglePostFetchStrategy.ts:93","s":"getDefaultEndpoint","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#getdefaultendpoint","p":574},{"i":618,"t":"▸ getDefaultParams(): Partial

Returns​ Partial

Overrides​ AbstractFetchStrategy.getDefaultParams Defined in​ packages/core/src/data/strategies/SinglePostFetchStrategy.ts:97","s":"getDefaultParams","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#getdefaultparams","p":574},{"i":620,"t":"▸ getEndpoint(): string Returns the endpoint of the strategy. If no endpoint has been set at runtime, returns the default endpoint Returns​ string The current endpoint for the strategy Inherited from​ AbstractFetchStrategy.getEndpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:160","s":"getEndpoint","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#getendpoint","p":574},{"i":622,"t":"▸ getParamsFromURL(path, nonUrlParams?): Partial

Returns the supported params from the URL if present. These params are passed to buildEndpointURL. If the strategy does not support mapping url params to endpoint params, it should return an empty object. Parameters​ Name Type Description path string The Path name nonUrlParams Partial

The non-url params Returns​ Partial

params extracted from the URL Overrides​ AbstractFetchStrategy.getParamsFromURL Defined in​ packages/core/src/data/strategies/SinglePostFetchStrategy.ts:102","s":"getParamsFromURL","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#getparamsfromurl","p":574},{"i":624,"t":"▸ getPostThatMatchesCurrentPath(result, params): undefined | T Returns only the post that matches the current path Parameters​ Name Type result T[] params Partial

Returns​ undefined | T Defined in​ packages/core/src/data/strategies/SinglePostFetchStrategy.ts:166","s":"getPostThatMatchesCurrentPath","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#getpostthatmatchescurrentpath","p":574},{"i":626,"t":"▸ getQueriedObject(response, params): Object Parameters​ Name Type response FetchResponse params Partial

Returns​ Object Inherited from​ AbstractFetchStrategy.getQueriedObject Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:327","s":"getQueriedObject","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#getqueriedobject","p":574},{"i":628,"t":"▸ isMainQuery(path, nonUrlParams): boolean Checks if this is the main query for a page Parameters​ Name Type Description path string The page name nonUrlParams Partial

The non-url params Returns​ boolean Inherited from​ AbstractFetchStrategy.isMainQuery Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:191","s":"isMainQuery","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#ismainquery","p":574},{"i":630,"t":"▸ normalizeForCache(data, params): NormalizedDataForCache Normalize data for cache. Parameters​ Name Type Description data FetchResponse The fetch response data params Partial

The request params Returns​ NormalizedDataForCache Inherited from​ AbstractFetchStrategy.normalizeForCache Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:379","s":"normalizeForCache","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#normalizeforcache","p":574},{"i":632,"t":"▸ prepareResponse(response, params): FetchResponse Prepares the post response Parameters​ Name Type response FetchResponse params Partial

Returns​ FetchResponse Overrides​ AbstractFetchStrategy.prepareResponse Defined in​ packages/core/src/data/strategies/SinglePostFetchStrategy.ts:205","s":"prepareResponse","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#prepareresponse","p":574},{"i":634,"t":"▸ setBaseURL(url?): void Parameters​ Name Type Default value url undefined | string '' Returns​ void Inherited from​ AbstractFetchStrategy.setBaseURL Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:150","s":"setBaseURL","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#setbaseurl","p":574},{"i":636,"t":"▸ setEndpoint(endpoint): void The strategy can switch endpoints at runtime if needed. E.g: The actual endpoint for a post depends on its post_type Parameters​ Name Type Description endpoint string The endpoint to fetch Returns​ void Inherited from​ AbstractFetchStrategy.setEndpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:146","s":"setEndpoint","u":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","h":"#setendpoint","p":574},{"i":638,"t":"@headstartwp/core.TaxonomyTermsStrategy This fetch strategy does not support extracting url params from the url","s":"Class: TaxonomyTermsStrategy","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"","p":637},{"i":640,"t":"Name Type T extends TermEntity = TermEntity P extends TaxonomyArchiveParams = TaxonomyArchiveParams","s":"Type parameters","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#type-parameters","p":637},{"i":642,"t":"AbstractFetchStrategy ↳ TaxonomyTermsStrategy","s":"Hierarchy","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#hierarchy","p":637},{"i":645,"t":"• new TaxonomyTermsStrategy(baseURL?, defaultParams?) The strategy constructor Type parameters​ Name Type T extends TermEntity = TermEntity P extends TaxonomyArchiveParams = TaxonomyArchiveParams Parameters​ Name Type Description baseURL? string The base URL of the API defaultParams? Partial

(optional) list of default params Inherited from​ AbstractFetchStrategy.constructor Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:129","s":"constructor","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#constructor","p":637},{"i":648,"t":"• baseURL: string = '' The base URL where the API is located Inherited from​ AbstractFetchStrategy.baseURL Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:115","s":"baseURL","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#baseurl","p":637},{"i":650,"t":"• defaultParams: Partial

= {} The Default Params Inherited from​ AbstractFetchStrategy.defaultParams Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:105","s":"defaultParams","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#defaultparams","p":637},{"i":652,"t":"• defaultTaxonomy: string = 'category' Defined in​ packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:103","s":"defaultTaxonomy","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#defaulttaxonomy","p":637},{"i":654,"t":"• endpoint: string = '' Holds the current endpoint for the strategy Inherited from​ AbstractFetchStrategy.endpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:110","s":"endpoint","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#endpoint","p":637},{"i":657,"t":"▸ buildEndpointURL(params): string Builds the final endpoint URL based on the passed parameters Parameters​ Name Type Description params Partial

The params to add to the request Returns​ string The endpoint URL. Overrides​ AbstractFetchStrategy.buildEndpointURL Defined in​ packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:122","s":"buildEndpointURL","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#buildendpointurl","p":637},{"i":659,"t":"▸ fetcher(url, params, options?): Promise> The default fetcher function The default fetcher function handles authentication headers and errors from the API. A custom strategy can override this function to run additional logic before or after the fetch call Parameters​ Name Type Description url string The URL to fetch params Partial

The request params options? Partial The fetcher options Returns​ Promise> Overrides​ AbstractFetchStrategy.fetcher Defined in​ packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:138","s":"fetcher","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#fetcher","p":637},{"i":661,"t":"▸ filterData(data, filterOptions?): FetchResponse Filters the data returned from the API by excluding fields that are not needed in order to reduce payload size. Parameters​ Name Type Description data FetchResponse The data to filter filterOptions? FilterDataOptions Filter options Returns​ FetchResponse The filtered data Overrides​ AbstractFetchStrategy.filterData Defined in​ packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:146","s":"filterData","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#filterdata","p":637},{"i":663,"t":"▸ get(params?): Promise> This is a simple wrapper to quickly fetch data from the API given a set of params","s":"get","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#get","p":637},{"i":665,"t":"import { PostsArchiveFetchStrategy } from '@headstartwp/core'; new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10}); Parameters​ Name Type Description params Partial

The endpoint params Returns​ Promise> Inherited from​ AbstractFetchStrategy.get Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:404","s":"Usage","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#usage","p":637},{"i":667,"t":"▸ getAuthHeader(options?): string Parameters​ Name Type options Partial Returns​ string Inherited from​ AbstractFetchStrategy.getAuthHeader Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:227","s":"getAuthHeader","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#getauthheader","p":637},{"i":669,"t":"▸ getCacheKey(params): Object Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites Parameters​ Name Type Description params Partial

The request params Returns​ Object The cache key object Name Type args Partial

& { sourceUrl: string } url string Inherited from​ AbstractFetchStrategy.getCacheKey Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:369","s":"getCacheKey","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#getcachekey","p":637},{"i":671,"t":"▸ getDefaultEndpoint(): string A method that must be implemented by concrete implementations which returns the default endpoint for the strategy Returns​ string Overrides​ AbstractFetchStrategy.getDefaultEndpoint Defined in​ packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:105","s":"getDefaultEndpoint","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#getdefaultendpoint","p":637},{"i":673,"t":"▸ getDefaultParams(): Partial

Returns​ Partial

Overrides​ AbstractFetchStrategy.getDefaultParams Defined in​ packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:109","s":"getDefaultParams","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#getdefaultparams","p":637},{"i":675,"t":"▸ getEndpoint(): string Returns the endpoint of the strategy. If no endpoint has been set at runtime, returns the default endpoint Returns​ string The current endpoint for the strategy Inherited from​ AbstractFetchStrategy.getEndpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:160","s":"getEndpoint","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#getendpoint","p":637},{"i":677,"t":"▸ getParamsFromURL(path, params?): Partial

Returns the supported params from the URL if present. These params are passed to buildEndpointURL. If the strategy does not support mapping url params to endpoint params, it should return an empty object. Parameters​ Name Type Description path string The Path name params Partial

The non-url params Returns​ Partial

params extracted from the URL Overrides​ AbstractFetchStrategy.getParamsFromURL Defined in​ packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:113","s":"getParamsFromURL","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#getparamsfromurl","p":637},{"i":679,"t":"▸ getQueriedObject(response, params): Object Parameters​ Name Type response FetchResponse params Partial

Returns​ Object Inherited from​ AbstractFetchStrategy.getQueriedObject Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:327","s":"getQueriedObject","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#getqueriedobject","p":637},{"i":681,"t":"▸ isMainQuery(path, nonUrlParams): boolean Checks if this is the main query for a page Parameters​ Name Type Description path string The page name nonUrlParams Partial

The non-url params Returns​ boolean Inherited from​ AbstractFetchStrategy.isMainQuery Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:191","s":"isMainQuery","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#ismainquery","p":637},{"i":683,"t":"▸ normalizeForCache(data, params): NormalizedDataForCache Normalize data for cache. Parameters​ Name Type Description data FetchResponse The fetch response data params Partial

The request params Returns​ NormalizedDataForCache Inherited from​ AbstractFetchStrategy.normalizeForCache Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:379","s":"normalizeForCache","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#normalizeforcache","p":637},{"i":685,"t":"▸ prepareResponse(response, params): FetchResponse Parameters​ Name Type response FetchResponse params Partial

Returns​ FetchResponse Inherited from​ AbstractFetchStrategy.prepareResponse Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:219","s":"prepareResponse","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#prepareresponse","p":637},{"i":687,"t":"▸ setBaseURL(url?): void Parameters​ Name Type Default value url undefined | string '' Returns​ void Inherited from​ AbstractFetchStrategy.setBaseURL Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:150","s":"setBaseURL","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#setbaseurl","p":637},{"i":689,"t":"▸ setEndpoint(endpoint): void The strategy can switch endpoints at runtime if needed. E.g: The actual endpoint for a post depends on its post_type Parameters​ Name Type Description endpoint string The endpoint to fetch Returns​ void Inherited from​ AbstractFetchStrategy.setEndpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:146","s":"setEndpoint","u":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","h":"#setendpoint","p":637},{"i":691,"t":"@headstartwp/core.LOGTYPE","s":"Enumeration: LOGTYPE","u":"/docs/api/enums/headstartwp_core.LOGTYPE/","h":"","p":690},{"i":694,"t":"• DEBUG = 0 Defined in​ packages/core/src/utils/log.ts:3","s":"DEBUG","u":"/docs/api/enums/headstartwp_core.LOGTYPE/","h":"#debug","p":690},{"i":696,"t":"• ERROR = 3 Defined in​ packages/core/src/utils/log.ts:6","s":"ERROR","u":"/docs/api/enums/headstartwp_core.LOGTYPE/","h":"#error","p":690},{"i":698,"t":"• INFO = 1 Defined in​ packages/core/src/utils/log.ts:4","s":"INFO","u":"/docs/api/enums/headstartwp_core.LOGTYPE/","h":"#info","p":690},{"i":700,"t":"• WARN = 2 Defined in​ packages/core/src/utils/log.ts:5","s":"WARN","u":"/docs/api/enums/headstartwp_core.LOGTYPE/","h":"#warn","p":690},{"i":702,"t":"@headstartwp/core.AuthorEntity Interface for entities from the /wp/v2/users endpoint.","s":"Interface: AuthorEntity","u":"/docs/api/interfaces/headstartwp_core.AuthorEntity/","h":"","p":701},{"i":704,"t":"Entity ↳ AuthorEntity","s":"Hierarchy","u":"/docs/api/interfaces/headstartwp_core.AuthorEntity/","h":"#hierarchy","p":701},{"i":707,"t":"• Optional avatar_urls: AvatarUrls Avatar URLs for the user. Defined in​ packages/core/src/data/types/entities.ts:540","s":"avatar_urls","u":"/docs/api/interfaces/headstartwp_core.AuthorEntity/","h":"#avatar_urls","p":701},{"i":709,"t":"• description: string Description of the user. Defined in​ packages/core/src/data/types/entities.ts:525","s":"description","u":"/docs/api/interfaces/headstartwp_core.AuthorEntity/","h":"#description","p":701},{"i":711,"t":"• id: number Unique identifier for the user. Defined in​ packages/core/src/data/types/entities.ts:510","s":"id","u":"/docs/api/interfaces/headstartwp_core.AuthorEntity/","h":"#id","p":701},{"i":713,"t":"• link: string Author URL of the user. Defined in​ packages/core/src/data/types/entities.ts:530","s":"link","u":"/docs/api/interfaces/headstartwp_core.AuthorEntity/","h":"#link","p":701},{"i":715,"t":"• meta: Record Meta fields. Defined in​ packages/core/src/data/types/entities.ts:545","s":"meta","u":"/docs/api/interfaces/headstartwp_core.AuthorEntity/","h":"#meta","p":701},{"i":717,"t":"• name: string Display name for the user. Defined in​ packages/core/src/data/types/entities.ts:515","s":"name","u":"/docs/api/interfaces/headstartwp_core.AuthorEntity/","h":"#name","p":701},{"i":719,"t":"• slug: string An alphanumeric identifier for the user. Defined in​ packages/core/src/data/types/entities.ts:535","s":"slug","u":"/docs/api/interfaces/headstartwp_core.AuthorEntity/","h":"#slug","p":701},{"i":721,"t":"• url: string URL of the user. Defined in​ packages/core/src/data/types/entities.ts:520","s":"url","u":"/docs/api/interfaces/headstartwp_core.AuthorEntity/","h":"#url","p":701},{"i":723,"t":"• Optional yoast_head: null | string Overrides​ Entity.yoast_head Defined in​ packages/core/src/data/types/entities.ts:548","s":"yoast_head","u":"/docs/api/interfaces/headstartwp_core.AuthorEntity/","h":"#yoast_head","p":701},{"i":725,"t":"• Optional yoast_head_json: null | Record Overrides​ Entity.yoast_head_json Defined in​ packages/core/src/data/types/entities.ts:547","s":"yoast_head_json","u":"/docs/api/interfaces/headstartwp_core.AuthorEntity/","h":"#yoast_head_json","p":701},{"i":727,"t":"@headstartwp/core.AppEntity Empty interface from which all entities inherit.","s":"Interface: AppEntity","u":"/docs/api/interfaces/headstartwp_core.AppEntity/","h":"","p":726},{"i":729,"t":"Entity ↳ AppEntity","s":"Hierarchy","u":"/docs/api/interfaces/headstartwp_core.AppEntity/","h":"#hierarchy","p":726},{"i":732,"t":"• home: Object Type declaration​ Name Type id? number slug? string Defined in​ packages/core/src/data/types/entities.ts:681","s":"home","u":"/docs/api/interfaces/headstartwp_core.AppEntity/","h":"#home","p":726},{"i":734,"t":"• menus: Object Index signature​ ▪ [k: string]: MenuItemEntity[] Defined in​ packages/core/src/data/types/entities.ts:678","s":"menus","u":"/docs/api/interfaces/headstartwp_core.AppEntity/","h":"#menus","p":726},{"i":736,"t":"• settings: Object Type declaration​ Name Type posts_per_page string privacy_policy_url string site_desc string site_name string site_rss_url string site_wp_url string Defined in​ packages/core/src/data/types/entities.ts:685","s":"settings","u":"/docs/api/interfaces/headstartwp_core.AppEntity/","h":"#settings","p":726},{"i":738,"t":"• theme.json: Record Defined in​ packages/core/src/data/types/entities.ts:693","s":"theme.json","u":"/docs/api/interfaces/headstartwp_core.AppEntity/","h":"#themejson","p":726},{"i":740,"t":"• Optional yoast_head: null | string Inherited from​ Entity.yoast_head Defined in​ packages/core/src/data/types/entities.ts:14","s":"yoast_head","u":"/docs/api/interfaces/headstartwp_core.AppEntity/","h":"#yoast_head","p":726},{"i":742,"t":"• Optional yoast_head_json: null | Record Inherited from​ Entity.yoast_head_json Defined in​ packages/core/src/data/types/entities.ts:13","s":"yoast_head_json","u":"/docs/api/interfaces/headstartwp_core.AppEntity/","h":"#yoast_head_json","p":726},{"i":744,"t":"@headstartwp/core.AvatarUrls Map of avatar URLs by their size.","s":"Interface: AvatarUrls","u":"/docs/api/interfaces/headstartwp_core.AvatarUrls/","h":"","p":743},{"i":746,"t":"▪ [k: string]: unknown","s":"Indexable","u":"/docs/api/interfaces/headstartwp_core.AvatarUrls/","h":"#indexable","p":743},{"i":749,"t":"• Optional 24: string Avatar URL with image size of 24 pixels. Defined in​ packages/core/src/data/types/entities.ts:489","s":"24","u":"/docs/api/interfaces/headstartwp_core.AvatarUrls/","h":"#24","p":743},{"i":751,"t":"• Optional 48: string Avatar URL with image size of 48 pixels. Defined in​ packages/core/src/data/types/entities.ts:494","s":"48","u":"/docs/api/interfaces/headstartwp_core.AvatarUrls/","h":"#48","p":743},{"i":753,"t":"• Optional 96: string Avatar URL with image size of 96 pixels. Defined in​ packages/core/src/data/types/entities.ts:499","s":"96","u":"/docs/api/interfaces/headstartwp_core.AvatarUrls/","h":"#96","p":743},{"i":755,"t":"@headstartwp/core.VerifyTokenFetchStrategy The Verify Token strategy is used to verify tokens issued by the headless wp plugin","s":"Class: VerifyTokenFetchStrategy","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","h":"","p":754},{"i":757,"t":"AbstractFetchStrategy ↳ VerifyTokenFetchStrategy","s":"Hierarchy","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","h":"#hierarchy","p":754},{"i":760,"t":"• new VerifyTokenFetchStrategy(baseURL?, defaultParams?) The strategy constructor Parameters​ Name Type Description baseURL? string The base URL of the API defaultParams? Partial (optional) list of default params Inherited from​ AbstractFetchStrategy.constructor Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:129","s":"constructor","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","h":"#constructor","p":754},{"i":763,"t":"• baseURL: string = '' The base URL where the API is located Inherited from​ AbstractFetchStrategy.baseURL Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:115","s":"baseURL","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","h":"#baseurl","p":754},{"i":765,"t":"• defaultParams: Partial = {} The Default Params Inherited from​ AbstractFetchStrategy.defaultParams Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:105","s":"defaultParams","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","h":"#defaultparams","p":754},{"i":767,"t":"• endpoint: string = '' Holds the current endpoint for the strategy Inherited from​ AbstractFetchStrategy.endpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:110","s":"endpoint","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","h":"#endpoint","p":754},{"i":770,"t":"▸ buildEndpointURL(params): string Builds the final endpoint URL based on the passed parameters Parameters​ Name Type Description params Partial The params to add to the request Returns​ string The endpoint URL. Overrides​ AbstractFetchStrategy.buildEndpointURL Defined in​ packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:32","s":"buildEndpointURL","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","h":"#buildendpointurl","p":754},{"i":772,"t":"▸ fetcher(url, params, options?): Promise> The default fetcher function The default fetcher function handles authentication headers and errors from the API. A custom strategy can override this function to run additional logic before or after the fetch call Parameters​ Name Type Description url string The URL to fetch params VerifyTokenParams The request params options Partial The fetcher options Returns​ Promise> Overrides​ AbstractFetchStrategy.fetcher Defined in​ packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:39","s":"fetcher","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","h":"#fetcher","p":754},{"i":774,"t":"▸ filterData(data, filterOptions?): FetchResponse Filters the data returned from the API by excluding fields that are not needed in order to reduce payload size. Parameters​ Name Type Description data FetchResponse The data to filter filterOptions? FilterDataOptions Filter options Returns​ FetchResponse The filtered data Inherited from​ AbstractFetchStrategy.filterData Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:339","s":"filterData","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","h":"#filterdata","p":754},{"i":776,"t":"▸ get(params?): Promise> This is a simple wrapper to quickly fetch data from the API given a set of params","s":"get","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","h":"#get","p":754},{"i":778,"t":"import { PostsArchiveFetchStrategy } from '@headstartwp/core'; new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10}); Parameters​ Name Type Description params Partial The endpoint params Returns​ Promise> Inherited from​ AbstractFetchStrategy.get Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:404","s":"Usage","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","h":"#usage","p":754},{"i":780,"t":"▸ getAuthHeader(options?): string Parameters​ Name Type options Partial Returns​ string Inherited from​ AbstractFetchStrategy.getAuthHeader Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:227","s":"getAuthHeader","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","h":"#getauthheader","p":754},{"i":782,"t":"▸ getCacheKey(params): Object Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites Parameters​ Name Type Description params Partial The request params Returns​ Object The cache key object Name Type args Partial & { sourceUrl: string } url string Inherited from​ AbstractFetchStrategy.getCacheKey Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:369","s":"getCacheKey","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","h":"#getcachekey","p":754},{"i":784,"t":"▸ getDefaultEndpoint(): string A method that must be implemented by concrete implementations which returns the default endpoint for the strategy Returns​ string Overrides​ AbstractFetchStrategy.getDefaultEndpoint Defined in​ packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:23","s":"getDefaultEndpoint","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","h":"#getdefaultendpoint","p":754},{"i":786,"t":"▸ getDefaultParams(): Partial Returns​ Partial Inherited from​ AbstractFetchStrategy.getDefaultParams Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:168","s":"getDefaultParams","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","h":"#getdefaultparams","p":754},{"i":788,"t":"▸ getEndpoint(): string Returns the endpoint of the strategy. If no endpoint has been set at runtime, returns the default endpoint Returns​ string The current endpoint for the strategy Inherited from​ AbstractFetchStrategy.getEndpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:160","s":"getEndpoint","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","h":"#getendpoint","p":754},{"i":790,"t":"▸ getParamsFromURL(path, params?): Partial Returns the supported params from the URL if present. These params are passed to buildEndpointURL. If the strategy does not support mapping url params to endpoint params, it should return an empty object. Parameters​ Name Type Description path string The Path name params Partial The non-url params Returns​ Partial params extracted from the URL Overrides​ AbstractFetchStrategy.getParamsFromURL Defined in​ packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:28","s":"getParamsFromURL","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","h":"#getparamsfromurl","p":754},{"i":792,"t":"▸ getQueriedObject(response, params): Object Parameters​ Name Type response FetchResponse params Partial Returns​ Object Inherited from​ AbstractFetchStrategy.getQueriedObject Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:327","s":"getQueriedObject","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","h":"#getqueriedobject","p":754},{"i":794,"t":"▸ isMainQuery(path, nonUrlParams): boolean Checks if this is the main query for a page Parameters​ Name Type Description path string The page name nonUrlParams Partial The non-url params Returns​ boolean Inherited from​ AbstractFetchStrategy.isMainQuery Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:191","s":"isMainQuery","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","h":"#ismainquery","p":754},{"i":796,"t":"▸ normalizeForCache(data, params): NormalizedDataForCache Normalize data for cache. Parameters​ Name Type Description data FetchResponse The fetch response data params Partial The request params Returns​ NormalizedDataForCache Inherited from​ AbstractFetchStrategy.normalizeForCache Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:379","s":"normalizeForCache","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","h":"#normalizeforcache","p":754},{"i":798,"t":"▸ prepareResponse(response, params): FetchResponse Parameters​ Name Type response FetchResponse params Partial Returns​ FetchResponse Inherited from​ AbstractFetchStrategy.prepareResponse Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:219","s":"prepareResponse","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","h":"#prepareresponse","p":754},{"i":800,"t":"▸ setBaseURL(url?): void Parameters​ Name Type Default value url undefined | string '' Returns​ void Inherited from​ AbstractFetchStrategy.setBaseURL Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:150","s":"setBaseURL","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","h":"#setbaseurl","p":754},{"i":802,"t":"▸ setEndpoint(endpoint): void The strategy can switch endpoints at runtime if needed. E.g: The actual endpoint for a post depends on its post_type Parameters​ Name Type Description endpoint string The endpoint to fetch Returns​ void Inherited from​ AbstractFetchStrategy.setEndpoint Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:146","s":"setEndpoint","u":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","h":"#setendpoint","p":754},{"i":804,"t":"@headstartwp/core.CommentEntity Interface for entities from the /wp/v2/comments endpoint.","s":"Interface: CommentEntity","u":"/docs/api/interfaces/headstartwp_core.CommentEntity/","h":"","p":803},{"i":806,"t":"Entity ↳ CommentEntity","s":"Hierarchy","u":"/docs/api/interfaces/headstartwp_core.CommentEntity/","h":"#hierarchy","p":803},{"i":809,"t":"• author: number The ID of the user object, if author was a user. Defined in​ packages/core/src/data/types/entities.ts:563","s":"author","u":"/docs/api/interfaces/headstartwp_core.CommentEntity/","h":"#author","p":803},{"i":811,"t":"• author_avatar_urls: AvatarUrls Avatar URLs for the object author. Defined in​ packages/core/src/data/types/entities.ts:623","s":"author_avatar_urls","u":"/docs/api/interfaces/headstartwp_core.CommentEntity/","h":"#author_avatar_urls","p":803},{"i":813,"t":"• author_email: string Email address for the object author. Defined in​ packages/core/src/data/types/entities.ts:568","s":"author_email","u":"/docs/api/interfaces/headstartwp_core.CommentEntity/","h":"#author_email","p":803},{"i":815,"t":"• author_name: string Display name for the object author. Defined in​ packages/core/src/data/types/entities.ts:573","s":"author_name","u":"/docs/api/interfaces/headstartwp_core.CommentEntity/","h":"#author_name","p":803},{"i":817,"t":"• author_url: string URL for the object author. Defined in​ packages/core/src/data/types/entities.ts:578","s":"author_url","u":"/docs/api/interfaces/headstartwp_core.CommentEntity/","h":"#author_url","p":803},{"i":819,"t":"• content: Rendered The content for the object. Defined in​ packages/core/src/data/types/entities.ts:583","s":"content","u":"/docs/api/interfaces/headstartwp_core.CommentEntity/","h":"#content","p":803},{"i":821,"t":"• date: string The date the object was published, in the site's timezone. Defined in​ packages/core/src/data/types/entities.ts:588","s":"date","u":"/docs/api/interfaces/headstartwp_core.CommentEntity/","h":"#date","p":803},{"i":823,"t":"• date_gmt: string The date the object was published, as GMT. Defined in​ packages/core/src/data/types/entities.ts:593","s":"date_gmt","u":"/docs/api/interfaces/headstartwp_core.CommentEntity/","h":"#date_gmt","p":803},{"i":825,"t":"• id: number Unique identifier for the object. Defined in​ packages/core/src/data/types/entities.ts:558","s":"id","u":"/docs/api/interfaces/headstartwp_core.CommentEntity/","h":"#id","p":803},{"i":827,"t":"• link: string URL to the object. Defined in​ packages/core/src/data/types/entities.ts:598","s":"link","u":"/docs/api/interfaces/headstartwp_core.CommentEntity/","h":"#link","p":803},{"i":829,"t":"• meta: Record Meta fields. Defined in​ packages/core/src/data/types/entities.ts:628","s":"meta","u":"/docs/api/interfaces/headstartwp_core.CommentEntity/","h":"#meta","p":803},{"i":831,"t":"• parent: number The ID for the parent of the object. Defined in​ packages/core/src/data/types/entities.ts:603","s":"parent","u":"/docs/api/interfaces/headstartwp_core.CommentEntity/","h":"#parent","p":803},{"i":833,"t":"• post: number The ID of the associated post object. Defined in​ packages/core/src/data/types/entities.ts:608","s":"post","u":"/docs/api/interfaces/headstartwp_core.CommentEntity/","h":"#post","p":803},{"i":835,"t":"• status: string State of the object. Defined in​ packages/core/src/data/types/entities.ts:613","s":"status","u":"/docs/api/interfaces/headstartwp_core.CommentEntity/","h":"#status","p":803},{"i":837,"t":"• type: \"comment\" Type of Comment for the object. Defined in​ packages/core/src/data/types/entities.ts:618","s":"type","u":"/docs/api/interfaces/headstartwp_core.CommentEntity/","h":"#type","p":803},{"i":839,"t":"• Optional yoast_head: null | string Inherited from​ Entity.yoast_head Defined in​ packages/core/src/data/types/entities.ts:14","s":"yoast_head","u":"/docs/api/interfaces/headstartwp_core.CommentEntity/","h":"#yoast_head","p":803},{"i":841,"t":"• Optional yoast_head_json: null | Record Inherited from​ Entity.yoast_head_json Defined in​ packages/core/src/data/types/entities.ts:13","s":"yoast_head_json","u":"/docs/api/interfaces/headstartwp_core.CommentEntity/","h":"#yoast_head_json","p":803},{"i":843,"t":"@headstartwp/core.EndpointParams The base interface for defining endpoint parameters Strategies should define type with the actually supported EndPointParams","s":"Interface: EndpointParams","u":"/docs/api/interfaces/headstartwp_core.EndpointParams/","h":"","p":842},{"i":845,"t":"EndpointParams ↳ PostParams ↳ PostsArchiveParams ↳ TaxonomyArchiveParams ↳ VerifyTokenParams ↳ PostOrPostsParams","s":"Hierarchy","u":"/docs/api/interfaces/headstartwp_core.EndpointParams/","h":"#hierarchy","p":842},{"i":847,"t":"▪ [k: string]: unknown","s":"Indexable","u":"/docs/api/interfaces/headstartwp_core.EndpointParams/","h":"#indexable","p":842},{"i":850,"t":"• Optional _embed: boolean The _embed param returned associated entities in the response It's recommended to avoid additional requests to fetch data Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:17","s":"_embed","u":"/docs/api/interfaces/headstartwp_core.EndpointParams/","h":"#_embed","p":842},{"i":852,"t":"• Optional _fields: string[] The _fields parameter is used to return only the specified fields in the response Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:22","s":"_fields","u":"/docs/api/interfaces/headstartwp_core.EndpointParams/","h":"#_fields","p":842},{"i":854,"t":"• Optional lang: string The polylang ?lang parameter. This is only used if the polylang integration is enabled Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:29","s":"lang","u":"/docs/api/interfaces/headstartwp_core.EndpointParams/","h":"#lang","p":842},{"i":856,"t":"@headstartwp/core.AttachmentEntity Interface for entities from the /wp/v2/media endpoint.","s":"Interface: AttachmentEntity","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"","p":855},{"i":858,"t":"PostTypeEntity ↳ AttachmentEntity","s":"Hierarchy","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#hierarchy","p":855},{"i":861,"t":"• _embedded: Object Type declaration​ Name Type author AuthorEntity[] wp:term TermEntity[][] Inherited from​ PostTypeEntity._embedded Defined in​ packages/core/src/data/types/entities.ts:98","s":"_embedded","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#_embedded","p":855},{"i":863,"t":"• alt_text: string Alternative text to display when attachment is not displayed. Defined in​ packages/core/src/data/types/entities.ts:259","s":"alt_text","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#alt_text","p":855},{"i":865,"t":"• Optional author: AuthorEntity[] Inherited from​ PostTypeEntity.author Defined in​ packages/core/src/data/types/entities.ts:94","s":"author","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#author","p":855},{"i":867,"t":"• caption: Rendered The attachment caption. Defined in​ packages/core/src/data/types/entities.ts:264","s":"caption","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#caption","p":855},{"i":869,"t":"• Optional comment_status: \"open\" | \"closed\" Whether or not comments are open on the object. Inherited from​ PostTypeEntity.comment_status Defined in​ packages/core/src/data/types/entities.ts:106","s":"comment_status","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#comment_status","p":855},{"i":871,"t":"• date: string The date the object was published, in the site's timezone. Inherited from​ PostTypeEntity.date Defined in​ packages/core/src/data/types/entities.ts:42","s":"date","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#date","p":855},{"i":873,"t":"• date_gmt: string The date the object was published, as GMT. Inherited from​ PostTypeEntity.date_gmt Defined in​ packages/core/src/data/types/entities.ts:47","s":"date_gmt","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#date_gmt","p":855},{"i":875,"t":"• description: Rendered The attachment description. Defined in​ packages/core/src/data/types/entities.ts:269","s":"description","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#description","p":855},{"i":877,"t":"• guid: Rendered The globally unique identifier for the object. Inherited from​ PostTypeEntity.guid Defined in​ packages/core/src/data/types/entities.ts:52","s":"guid","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#guid","p":855},{"i":879,"t":"• id: number Unique identifier for the object. Inherited from​ PostTypeEntity.id Defined in​ packages/core/src/data/types/entities.ts:67","s":"id","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#id","p":855},{"i":881,"t":"• link: string URL to the object. Inherited from​ PostTypeEntity.link Defined in​ packages/core/src/data/types/entities.ts:72","s":"link","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#link","p":855},{"i":883,"t":"• Optional media_details: Object Details about the media file, specific to its type. Type declaration​ Name Type Description file string The file path relative to wp-content/uploads. height number The height of the attachment. image_meta Record The metadata of the attachment. sizes Record The different sizes that WordPress created for this attachment. width number The width of the attachment. Defined in​ packages/core/src/data/types/entities.ts:284","s":"media_details","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#media_details","p":855},{"i":885,"t":"• media_type: \"image\" | \"file\" Attachment type. Defined in​ packages/core/src/data/types/entities.ts:274","s":"media_type","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#media_type","p":855},{"i":887,"t":"• Optional meta: Record Meta fields. Defined in​ packages/core/src/data/types/entities.ts:249","s":"meta","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#meta","p":855},{"i":889,"t":"• mime_type: string The attachment MIME type. Defined in​ packages/core/src/data/types/entities.ts:279","s":"mime_type","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#mime_type","p":855},{"i":891,"t":"• missing_image_sizes: string[] List of the missing image sizes of the attachment. Defined in​ packages/core/src/data/types/entities.ts:352","s":"missing_image_sizes","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#missing_image_sizes","p":855},{"i":893,"t":"• modified: string The date the object was last modified, in the site's timezone. Inherited from​ PostTypeEntity.modified Defined in​ packages/core/src/data/types/entities.ts:57","s":"modified","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#modified","p":855},{"i":895,"t":"• modified_gmt: string The date the object was last modified, as GMT. Inherited from​ PostTypeEntity.modified_gmt Defined in​ packages/core/src/data/types/entities.ts:62","s":"modified_gmt","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#modified_gmt","p":855},{"i":897,"t":"• ping_status: \"open\" | \"closed\" Whether or not the object can be pinged. Inherited from​ PostTypeEntity.ping_status Defined in​ packages/core/src/data/types/entities.ts:111","s":"ping_status","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#ping_status","p":855},{"i":899,"t":"• post: number The ID for the associated post of the attachment. Defined in​ packages/core/src/data/types/entities.ts:342","s":"post","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#post","p":855},{"i":901,"t":"• slug: string An alphanumeric identifier for the object unique to its type. Inherited from​ PostTypeEntity.slug Defined in​ packages/core/src/data/types/entities.ts:77","s":"slug","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#slug","p":855},{"i":903,"t":"• source_url: string URL to the original attachment file. Defined in​ packages/core/src/data/types/entities.ts:347","s":"source_url","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#source_url","p":855},{"i":905,"t":"• status: \"publish\" | \"future\" | \"draft\" | \"pending\" | \"private\" A named status for the object. Inherited from​ PostTypeEntity.status Defined in​ packages/core/src/data/types/entities.ts:82","s":"status","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#status","p":855},{"i":907,"t":"• Optional template: string The theme file to use to display the object. Defined in​ packages/core/src/data/types/entities.ts:254","s":"template","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#template","p":855},{"i":909,"t":"• Optional terms: Record Inherited from​ PostTypeEntity.terms Defined in​ packages/core/src/data/types/entities.ts:96","s":"terms","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#terms","p":855},{"i":911,"t":"• title: Rendered The title for the object. Inherited from​ PostTypeEntity.title Defined in​ packages/core/src/data/types/entities.ts:92","s":"title","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#title","p":855},{"i":913,"t":"• type: \"attachment\" Type of Post for the object. Overrides​ PostTypeEntity.type Defined in​ packages/core/src/data/types/entities.ts:244","s":"type","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#type","p":855},{"i":915,"t":"• Optional yoast_head: null | string Inherited from​ PostTypeEntity.yoast_head Defined in​ packages/core/src/data/types/entities.ts:114","s":"yoast_head","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#yoast_head","p":855},{"i":917,"t":"• Optional yoast_head_json: null | Record Inherited from​ PostTypeEntity.yoast_head_json Defined in​ packages/core/src/data/types/entities.ts:113","s":"yoast_head_json","u":"/docs/api/interfaces/headstartwp_core.AttachmentEntity/","h":"#yoast_head_json","p":855},{"i":919,"t":"@headstartwp/core.FetchOptions The options supported by the default fetcher method","s":"Interface: FetchOptions","u":"/docs/api/interfaces/headstartwp_core.FetchOptions/","h":"","p":918},{"i":922,"t":"• Optional bearerToken: string The authentication token to use for the request. Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:66","s":"bearerToken","u":"/docs/api/interfaces/headstartwp_core.FetchOptions/","h":"#bearertoken","p":918},{"i":924,"t":"• Optional burstCache: boolean Whether to burst cache by appending a timestamp to the query Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:71","s":"burstCache","u":"/docs/api/interfaces/headstartwp_core.FetchOptions/","h":"#burstcache","p":918},{"i":926,"t":"• throwIfNotFound: boolean Whether to thrown an exception if data is not found. Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:61","s":"throwIfNotFound","u":"/docs/api/interfaces/headstartwp_core.FetchOptions/","h":"#throwifnotfound","p":918},{"i":928,"t":"@headstartwp/core.FetchResponse The type of the fetch response","s":"Interface: FetchResponse","u":"/docs/api/interfaces/headstartwp_core.FetchResponse/","h":"","p":927},{"i":930,"t":"Name T","s":"Type parameters","u":"/docs/api/interfaces/headstartwp_core.FetchResponse/","h":"#type-parameters","p":927},{"i":933,"t":"• pageInfo: PageInfo Contains pagination information Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:46","s":"pageInfo","u":"/docs/api/interfaces/headstartwp_core.FetchResponse/","h":"#pageinfo","p":927},{"i":935,"t":"• queriedObject: QueriedObject Queried Object information Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:51","s":"queriedObject","u":"/docs/api/interfaces/headstartwp_core.FetchResponse/","h":"#queriedobject","p":927},{"i":937,"t":"• result: T Contains the actual data returned from the API Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:41","s":"result","u":"/docs/api/interfaces/headstartwp_core.FetchResponse/","h":"#result","p":927},{"i":939,"t":"@headstartwp/core.HTMLReactParserOptions","s":"Interface: HTMLReactParserOptions","u":"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions/","h":"","p":938},{"i":942,"t":"• Optional htmlparser2: HTMLParser2Options Defined in​ node_modules/html-react-parser/index.d.ts:24","s":"htmlparser2","u":"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions/","h":"#htmlparser2","p":938},{"i":944,"t":"• Optional library: Object Index signature​ ▪ [key: string]: any Type declaration​ Name Type cloneElement (element: Element, props?: object, ...children: any) => Element createElement (type: any, props?: object, ...children: any) => Element isValidElement (element: any) => boolean Defined in​ node_modules/html-react-parser/index.d.ts:26","s":"library","u":"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions/","h":"#library","p":938},{"i":946,"t":"• Optional replace: (domNode: DOMNode) => undefined | null | false | void | object | Element Type declaration​ ▸ (domNode): undefined | null | false | void | object | Element Parameters​ Name Type domNode DOMNode Returns​ undefined | null | false | void | object | Element Defined in​ node_modules/html-react-parser/index.d.ts:37","s":"replace","u":"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions/","h":"#replace","p":938},{"i":948,"t":"• Optional trim: boolean Defined in​ node_modules/html-react-parser/index.d.ts:41","s":"trim","u":"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions/","h":"#trim","p":938},{"i":950,"t":"@headstartwp/core.Entity Empty interface from which all entities inherit.","s":"Interface: Entity","u":"/docs/api/interfaces/headstartwp_core.Entity/","h":"","p":949},{"i":952,"t":"Entity ↳ PostTypeEntity ↳ TypeEntity ↳ TaxonomyEntity ↳ TermEntity ↳ AuthorEntity ↳ CommentEntity ↳ SearchEntity ↳ AppEntity","s":"Hierarchy","u":"/docs/api/interfaces/headstartwp_core.Entity/","h":"#hierarchy","p":949},{"i":954,"t":"▪ [k: string]: unknown","s":"Indexable","u":"/docs/api/interfaces/headstartwp_core.Entity/","h":"#indexable","p":949},{"i":957,"t":"• Optional yoast_head: null | string Defined in​ packages/core/src/data/types/entities.ts:14","s":"yoast_head","u":"/docs/api/interfaces/headstartwp_core.Entity/","h":"#yoast_head","p":949},{"i":959,"t":"• Optional yoast_head_json: null | Record Defined in​ packages/core/src/data/types/entities.ts:13","s":"yoast_head_json","u":"/docs/api/interfaces/headstartwp_core.Entity/","h":"#yoast_head_json","p":949},{"i":961,"t":"@headstartwp/core.Integration","s":"Interface: Integration","u":"/docs/api/interfaces/headstartwp_core.Integration/","h":"","p":960},{"i":963,"t":"Integration ↳ YoastSEOIntegration ↳ PolylangIntegration","s":"Hierarchy","u":"/docs/api/interfaces/headstartwp_core.Integration/","h":"#hierarchy","p":960},{"i":966,"t":"• enable: boolean Defined in​ packages/core/src/types.ts:46","s":"enable","u":"/docs/api/interfaces/headstartwp_core.Integration/","h":"#enable","p":960},{"i":968,"t":"@headstartwp/core.FilterDataOptions","s":"Interface: FilterDataOptions","u":"/docs/api/interfaces/headstartwp_core.FilterDataOptions/","h":"","p":967},{"i":970,"t":"Name T","s":"Type parameters","u":"/docs/api/interfaces/headstartwp_core.FilterDataOptions/","h":"#type-parameters","p":967},{"i":973,"t":"• fields: keyof T[] Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:80","s":"fields","u":"/docs/api/interfaces/headstartwp_core.FilterDataOptions/","h":"#fields","p":967},{"i":975,"t":"• method: \"ALLOW\" | \"REMOVE\" If method is 'ALLOW' then only the fields specified in the filter will be returned. If method is 'REMOVE' then the fields specified in the filter will be removed. Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:79","s":"method","u":"/docs/api/interfaces/headstartwp_core.FilterDataOptions/","h":"#method","p":967},{"i":977,"t":"@headstartwp/core.PageInfo","s":"Interface: PageInfo","u":"/docs/api/interfaces/headstartwp_core.PageInfo/","h":"","p":976},{"i":980,"t":"• page: number Defined in​ packages/core/src/data/types/entities.ts:699","s":"page","u":"/docs/api/interfaces/headstartwp_core.PageInfo/","h":"#page","p":976},{"i":982,"t":"• totalItems: number Defined in​ packages/core/src/data/types/entities.ts:698","s":"totalItems","u":"/docs/api/interfaces/headstartwp_core.PageInfo/","h":"#totalitems","p":976},{"i":984,"t":"• totalPages: number Defined in​ packages/core/src/data/types/entities.ts:697","s":"totalPages","u":"/docs/api/interfaces/headstartwp_core.PageInfo/","h":"#totalpages","p":976},{"i":986,"t":"@headstartwp/core.PolylangIntegration","s":"Interface: PolylangIntegration","u":"/docs/api/interfaces/headstartwp_core.PolylangIntegration/","h":"","p":985},{"i":988,"t":"Integration ↳ PolylangIntegration","s":"Hierarchy","u":"/docs/api/interfaces/headstartwp_core.PolylangIntegration/","h":"#hierarchy","p":985},{"i":991,"t":"• enable: boolean Inherited from​ Integration.enable Defined in​ packages/core/src/types.ts:46","s":"enable","u":"/docs/api/interfaces/headstartwp_core.PolylangIntegration/","h":"#enable","p":985},{"i":993,"t":"@headstartwp/core.PageEntity Interface for entities from the /wp/v2/pages endpoint.","s":"Interface: PageEntity","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"","p":992},{"i":995,"t":"PostTypeEntity ↳ PageEntity","s":"Hierarchy","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#hierarchy","p":992},{"i":998,"t":"• _embedded: Object Type declaration​ Name Type author AuthorEntity[] wp:term TermEntity[][] Inherited from​ PostTypeEntity._embedded Defined in​ packages/core/src/data/types/entities.ts:98","s":"_embedded","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#_embedded","p":992},{"i":1000,"t":"• Optional author: AuthorEntity[] Inherited from​ PostTypeEntity.author Defined in​ packages/core/src/data/types/entities.ts:94","s":"author","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#author","p":992},{"i":1002,"t":"• Optional comment_status: \"open\" | \"closed\" Whether or not comments are open on the object. Inherited from​ PostTypeEntity.comment_status Defined in​ packages/core/src/data/types/entities.ts:106","s":"comment_status","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#comment_status","p":992},{"i":1004,"t":"• content: Rendered The content for the object. Defined in​ packages/core/src/data/types/entities.ts:209","s":"content","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#content","p":992},{"i":1006,"t":"• date: string The date the object was published, in the site's timezone. Inherited from​ PostTypeEntity.date Defined in​ packages/core/src/data/types/entities.ts:42","s":"date","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#date","p":992},{"i":1008,"t":"• date_gmt: string The date the object was published, as GMT. Inherited from​ PostTypeEntity.date_gmt Defined in​ packages/core/src/data/types/entities.ts:47","s":"date_gmt","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#date_gmt","p":992},{"i":1010,"t":"• excerpt: Rendered The excerpt for the object. Defined in​ packages/core/src/data/types/entities.ts:214","s":"excerpt","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#excerpt","p":992},{"i":1012,"t":"• featured_media: number The ID of the featured media for the object. Defined in​ packages/core/src/data/types/entities.ts:234","s":"featured_media","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#featured_media","p":992},{"i":1014,"t":"• guid: Rendered The globally unique identifier for the object. Inherited from​ PostTypeEntity.guid Defined in​ packages/core/src/data/types/entities.ts:52","s":"guid","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#guid","p":992},{"i":1016,"t":"• id: number Unique identifier for the object. Inherited from​ PostTypeEntity.id Defined in​ packages/core/src/data/types/entities.ts:67","s":"id","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#id","p":992},{"i":1018,"t":"• link: string URL to the object. Inherited from​ PostTypeEntity.link Defined in​ packages/core/src/data/types/entities.ts:72","s":"link","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#link","p":992},{"i":1020,"t":"• menu_order: number The order of the object in relation to other object of its type. Defined in​ packages/core/src/data/types/entities.ts:219","s":"menu_order","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#menu_order","p":992},{"i":1022,"t":"• meta: Record Meta fields. Defined in​ packages/core/src/data/types/entities.ts:224","s":"meta","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#meta","p":992},{"i":1024,"t":"• modified: string The date the object was last modified, in the site's timezone. Inherited from​ PostTypeEntity.modified Defined in​ packages/core/src/data/types/entities.ts:57","s":"modified","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#modified","p":992},{"i":1026,"t":"• modified_gmt: string The date the object was last modified, as GMT. Inherited from​ PostTypeEntity.modified_gmt Defined in​ packages/core/src/data/types/entities.ts:62","s":"modified_gmt","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#modified_gmt","p":992},{"i":1028,"t":"• parent: number The ID for the parent of the object. Defined in​ packages/core/src/data/types/entities.ts:204","s":"parent","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#parent","p":992},{"i":1030,"t":"• ping_status: \"open\" | \"closed\" Whether or not the object can be pinged. Inherited from​ PostTypeEntity.ping_status Defined in​ packages/core/src/data/types/entities.ts:111","s":"ping_status","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#ping_status","p":992},{"i":1032,"t":"• slug: string An alphanumeric identifier for the object unique to its type. Inherited from​ PostTypeEntity.slug Defined in​ packages/core/src/data/types/entities.ts:77","s":"slug","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#slug","p":992},{"i":1034,"t":"• status: \"publish\" | \"future\" | \"draft\" | \"pending\" | \"private\" A named status for the object. Inherited from​ PostTypeEntity.status Defined in​ packages/core/src/data/types/entities.ts:82","s":"status","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#status","p":992},{"i":1036,"t":"• template: string The theme file to use to display the object. Defined in​ packages/core/src/data/types/entities.ts:229","s":"template","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#template","p":992},{"i":1038,"t":"• Optional terms: Record Inherited from​ PostTypeEntity.terms Defined in​ packages/core/src/data/types/entities.ts:96","s":"terms","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#terms","p":992},{"i":1040,"t":"• title: Rendered The title for the object. Inherited from​ PostTypeEntity.title Defined in​ packages/core/src/data/types/entities.ts:92","s":"title","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#title","p":992},{"i":1042,"t":"• type: string Type of Post for the object. Inherited from​ PostTypeEntity.type Defined in​ packages/core/src/data/types/entities.ts:87","s":"type","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#type","p":992},{"i":1044,"t":"• Optional yoast_head: null | string Inherited from​ PostTypeEntity.yoast_head Defined in​ packages/core/src/data/types/entities.ts:114","s":"yoast_head","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#yoast_head","p":992},{"i":1046,"t":"• Optional yoast_head_json: null | Record Inherited from​ PostTypeEntity.yoast_head_json Defined in​ packages/core/src/data/types/entities.ts:113","s":"yoast_head_json","u":"/docs/api/interfaces/headstartwp_core.PageEntity/","h":"#yoast_head_json","p":992},{"i":1048,"t":"@headstartwp/core.MenuItemEntity","s":"Interface: MenuItemEntity","u":"/docs/api/interfaces/headstartwp_core.MenuItemEntity/","h":"","p":1047},{"i":1051,"t":"• ID: number Defined in​ packages/core/src/data/types/entities.ts:657","s":"ID","u":"/docs/api/interfaces/headstartwp_core.MenuItemEntity/","h":"#id","p":1047},{"i":1053,"t":"• attr_title: string Defined in​ packages/core/src/data/types/entities.ts:669","s":"attr_title","u":"/docs/api/interfaces/headstartwp_core.MenuItemEntity/","h":"#attr_title","p":1047},{"i":1055,"t":"• children: MenuItemEntity[] Defined in​ packages/core/src/data/types/entities.ts:673","s":"children","u":"/docs/api/interfaces/headstartwp_core.MenuItemEntity/","h":"#children","p":1047},{"i":1057,"t":"• classes: string[] Defined in​ packages/core/src/data/types/entities.ts:671","s":"classes","u":"/docs/api/interfaces/headstartwp_core.MenuItemEntity/","h":"#classes","p":1047},{"i":1059,"t":"• description: string Defined in​ packages/core/src/data/types/entities.ts:670","s":"description","u":"/docs/api/interfaces/headstartwp_core.MenuItemEntity/","h":"#description","p":1047},{"i":1061,"t":"• menu_item_parent: string Defined in​ packages/core/src/data/types/entities.ts:661","s":"menu_item_parent","u":"/docs/api/interfaces/headstartwp_core.MenuItemEntity/","h":"#menu_item_parent","p":1047},{"i":1063,"t":"• menu_order: number Defined in​ packages/core/src/data/types/entities.ts:658","s":"menu_order","u":"/docs/api/interfaces/headstartwp_core.MenuItemEntity/","h":"#menu_order","p":1047},{"i":1065,"t":"• object: string Defined in​ packages/core/src/data/types/entities.ts:663","s":"object","u":"/docs/api/interfaces/headstartwp_core.MenuItemEntity/","h":"#object","p":1047},{"i":1067,"t":"• object_id: string Defined in​ packages/core/src/data/types/entities.ts:662","s":"object_id","u":"/docs/api/interfaces/headstartwp_core.MenuItemEntity/","h":"#object_id","p":1047},{"i":1069,"t":"• order: number Defined in​ packages/core/src/data/types/entities.ts:674","s":"order","u":"/docs/api/interfaces/headstartwp_core.MenuItemEntity/","h":"#order","p":1047},{"i":1071,"t":"• post_mime_type: string Defined in​ packages/core/src/data/types/entities.ts:660","s":"post_mime_type","u":"/docs/api/interfaces/headstartwp_core.MenuItemEntity/","h":"#post_mime_type","p":1047},{"i":1073,"t":"• post_type: string Defined in​ packages/core/src/data/types/entities.ts:659","s":"post_type","u":"/docs/api/interfaces/headstartwp_core.MenuItemEntity/","h":"#post_type","p":1047},{"i":1075,"t":"• slug: string Defined in​ packages/core/src/data/types/entities.ts:672","s":"slug","u":"/docs/api/interfaces/headstartwp_core.MenuItemEntity/","h":"#slug","p":1047},{"i":1077,"t":"• target: \"_blank\" | \"_self\" | \"_parent\" | \"_top\" Defined in​ packages/core/src/data/types/entities.ts:668","s":"target","u":"/docs/api/interfaces/headstartwp_core.MenuItemEntity/","h":"#target","p":1047},{"i":1079,"t":"• title: string Defined in​ packages/core/src/data/types/entities.ts:667","s":"title","u":"/docs/api/interfaces/headstartwp_core.MenuItemEntity/","h":"#title","p":1047},{"i":1081,"t":"• type: string Defined in​ packages/core/src/data/types/entities.ts:664","s":"type","u":"/docs/api/interfaces/headstartwp_core.MenuItemEntity/","h":"#type","p":1047},{"i":1083,"t":"• type_label: string Defined in​ packages/core/src/data/types/entities.ts:665","s":"type_label","u":"/docs/api/interfaces/headstartwp_core.MenuItemEntity/","h":"#type_label","p":1047},{"i":1085,"t":"• url: string Defined in​ packages/core/src/data/types/entities.ts:666","s":"url","u":"/docs/api/interfaces/headstartwp_core.MenuItemEntity/","h":"#url","p":1047},{"i":1087,"t":"@headstartwp/core.PostEntity Interface for entities from the /wp/v2/posts endpoint.","s":"Interface: PostEntity","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"","p":1086},{"i":1089,"t":"PostTypeEntity ↳ PostEntity","s":"Hierarchy","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#hierarchy","p":1086},{"i":1092,"t":"• _embedded: Object Type declaration​ Name Type author AuthorEntity[] wp:term TermEntity[][] Inherited from​ PostTypeEntity._embedded Defined in​ packages/core/src/data/types/entities.ts:98","s":"_embedded","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#_embedded","p":1086},{"i":1094,"t":"• Optional author: AuthorEntity[] Inherited from​ PostTypeEntity.author Defined in​ packages/core/src/data/types/entities.ts:94","s":"author","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#author","p":1086},{"i":1096,"t":"• Optional categories: number[] The terms assigned to the object in the category taxonomy. Defined in​ packages/core/src/data/types/entities.ts:164","s":"categories","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#categories","p":1086},{"i":1098,"t":"• Optional comment_status: \"open\" | \"closed\" Whether or not comments are open on the object. Inherited from​ PostTypeEntity.comment_status Defined in​ packages/core/src/data/types/entities.ts:106","s":"comment_status","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#comment_status","p":1086},{"i":1100,"t":"• content: Rendered The content for the object. Defined in​ packages/core/src/data/types/entities.ts:124","s":"content","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#content","p":1086},{"i":1102,"t":"• date: string The date the object was published, in the site's timezone. Inherited from​ PostTypeEntity.date Defined in​ packages/core/src/data/types/entities.ts:42","s":"date","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#date","p":1086},{"i":1104,"t":"• date_gmt: string The date the object was published, as GMT. Inherited from​ PostTypeEntity.date_gmt Defined in​ packages/core/src/data/types/entities.ts:47","s":"date_gmt","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#date_gmt","p":1086},{"i":1106,"t":"• excerpt: Rendered The excerpt for the object. Defined in​ packages/core/src/data/types/entities.ts:129","s":"excerpt","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#excerpt","p":1086},{"i":1108,"t":"• featured_media: number The ID of the featured media for the object. Defined in​ packages/core/src/data/types/entities.ts:174","s":"featured_media","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#featured_media","p":1086},{"i":1110,"t":"• format: \"link\" | \"status\" | \"standard\" | \"aside\" | \"chat\" | \"gallery\" | \"image\" | \"quote\" | \"video\" | \"audio\" The format for the object. Defined in​ packages/core/src/data/types/entities.ts:134","s":"format","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#format","p":1086},{"i":1112,"t":"• guid: Rendered The globally unique identifier for the object. Inherited from​ PostTypeEntity.guid Defined in​ packages/core/src/data/types/entities.ts:52","s":"guid","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#guid","p":1086},{"i":1114,"t":"• id: number Unique identifier for the object. Inherited from​ PostTypeEntity.id Defined in​ packages/core/src/data/types/entities.ts:67","s":"id","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#id","p":1086},{"i":1116,"t":"• link: string URL to the object. Inherited from​ PostTypeEntity.link Defined in​ packages/core/src/data/types/entities.ts:72","s":"link","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#link","p":1086},{"i":1118,"t":"• meta: Record Meta fields. Defined in​ packages/core/src/data/types/entities.ts:149","s":"meta","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#meta","p":1086},{"i":1120,"t":"• modified: string The date the object was last modified, in the site's timezone. Inherited from​ PostTypeEntity.modified Defined in​ packages/core/src/data/types/entities.ts:57","s":"modified","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#modified","p":1086},{"i":1122,"t":"• modified_gmt: string The date the object was last modified, as GMT. Inherited from​ PostTypeEntity.modified_gmt Defined in​ packages/core/src/data/types/entities.ts:62","s":"modified_gmt","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#modified_gmt","p":1086},{"i":1124,"t":"• ping_status: \"open\" | \"closed\" Whether or not the object can be pinged. Inherited from​ PostTypeEntity.ping_status Defined in​ packages/core/src/data/types/entities.ts:111","s":"ping_status","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#ping_status","p":1086},{"i":1126,"t":"• slug: string An alphanumeric identifier for the object unique to its type. Inherited from​ PostTypeEntity.slug Defined in​ packages/core/src/data/types/entities.ts:77","s":"slug","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#slug","p":1086},{"i":1128,"t":"• status: \"publish\" | \"future\" | \"draft\" | \"pending\" | \"private\" A named status for the object. Inherited from​ PostTypeEntity.status Defined in​ packages/core/src/data/types/entities.ts:82","s":"status","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#status","p":1086},{"i":1130,"t":"• sticky: boolean Whether or not the object should be treated as sticky. Defined in​ packages/core/src/data/types/entities.ts:154","s":"sticky","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#sticky","p":1086},{"i":1132,"t":"• Optional tags: number[] The terms assigned to the object in the post_tag taxonomy. Defined in​ packages/core/src/data/types/entities.ts:169","s":"tags","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#tags","p":1086},{"i":1134,"t":"• template: string The theme file to use to display the object. Defined in​ packages/core/src/data/types/entities.ts:159","s":"template","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#template","p":1086},{"i":1136,"t":"• Optional terms: Record Inherited from​ PostTypeEntity.terms Defined in​ packages/core/src/data/types/entities.ts:96","s":"terms","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#terms","p":1086},{"i":1138,"t":"• title: Rendered The title for the object. Inherited from​ PostTypeEntity.title Defined in​ packages/core/src/data/types/entities.ts:92","s":"title","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#title","p":1086},{"i":1140,"t":"• type: string Type of Post for the object. Inherited from​ PostTypeEntity.type Defined in​ packages/core/src/data/types/entities.ts:87","s":"type","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#type","p":1086},{"i":1142,"t":"• Optional yoast_head: null | string Inherited from​ PostTypeEntity.yoast_head Defined in​ packages/core/src/data/types/entities.ts:114","s":"yoast_head","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#yoast_head","p":1086},{"i":1144,"t":"• Optional yoast_head_json: null | Record Inherited from​ PostTypeEntity.yoast_head_json Defined in​ packages/core/src/data/types/entities.ts:113","s":"yoast_head_json","u":"/docs/api/interfaces/headstartwp_core.PostEntity/","h":"#yoast_head_json","p":1086},{"i":1146,"t":"@headstartwp/core.PostParams The EndpointParams supported by the SinglePostFetchStrategy","s":"Interface: PostParams","u":"/docs/api/interfaces/headstartwp_core.PostParams/","h":"","p":1145},{"i":1148,"t":"EndpointParams ↳ PostParams","s":"Hierarchy","u":"/docs/api/interfaces/headstartwp_core.PostParams/","h":"#hierarchy","p":1145},{"i":1151,"t":"• Optional _embed: boolean The _embed param returned associated entities in the response It's recommended to avoid additional requests to fetch data Inherited from​ EndpointParams._embed Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:17","s":"_embed","u":"/docs/api/interfaces/headstartwp_core.PostParams/","h":"#_embed","p":1145},{"i":1153,"t":"• Optional _fields: string[] The _fields parameter is used to return only the specified fields in the response Inherited from​ EndpointParams._fields Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:22","s":"_fields","u":"/docs/api/interfaces/headstartwp_core.PostParams/","h":"#_fields","p":1145},{"i":1155,"t":"• Optional authToken: string The authToken, required to fetch revisions or non-published posts Defined in​ packages/core/src/data/strategies/SinglePostFetchStrategy.ts:53","s":"authToken","u":"/docs/api/interfaces/headstartwp_core.PostParams/","h":"#authtoken","p":1145},{"i":1157,"t":"• Optional fullPath: string If set, this is the path that will be checked if slug is set or matchCurrentPath is set to true. Defined in​ packages/core/src/data/strategies/SinglePostFetchStrategy.ts:63","s":"fullPath","u":"/docs/api/interfaces/headstartwp_core.PostParams/","h":"#fullpath","p":1145},{"i":1159,"t":"• Optional id: Number Fetch post by id Defined in​ packages/core/src/data/strategies/SinglePostFetchStrategy.ts:43","s":"id","u":"/docs/api/interfaces/headstartwp_core.PostParams/","h":"#id","p":1145},{"i":1161,"t":"• Optional lang: string The polylang ?lang parameter. This is only used if the polylang integration is enabled Inherited from​ EndpointParams.lang Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:29","s":"lang","u":"/docs/api/interfaces/headstartwp_core.PostParams/","h":"#lang","p":1145},{"i":1163,"t":"• Optional matchCurrentPath: boolean Whether post.link should be checked against current path Defined in​ packages/core/src/data/strategies/SinglePostFetchStrategy.ts:58","s":"matchCurrentPath","u":"/docs/api/interfaces/headstartwp_core.PostParams/","h":"#matchcurrentpath","p":1145},{"i":1165,"t":"• Optional postType: string | string[] Post Types where we should look for If multiple post types are specified multiple requests will be issued to each post type until a matching post is found Defined in​ packages/core/src/data/strategies/SinglePostFetchStrategy.ts:38","s":"postType","u":"/docs/api/interfaces/headstartwp_core.PostParams/","h":"#posttype","p":1145},{"i":1167,"t":"• Optional revision: Boolean If set will fetch the latest post revision Defined in​ packages/core/src/data/strategies/SinglePostFetchStrategy.ts:48","s":"revision","u":"/docs/api/interfaces/headstartwp_core.PostParams/","h":"#revision","p":1145},{"i":1169,"t":"• Optional slug: string The slug of the post to fetch Defined in​ packages/core/src/data/strategies/SinglePostFetchStrategy.ts:30","s":"slug","u":"/docs/api/interfaces/headstartwp_core.PostParams/","h":"#slug","p":1145},{"i":1171,"t":"@headstartwp/core.PostsArchiveParams The EndpointParams supported by the PostsArchiveFetchStrategy","s":"Interface: PostsArchiveParams","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"","p":1170},{"i":1173,"t":"EndpointParams ↳ PostsArchiveParams","s":"Hierarchy","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#hierarchy","p":1170},{"i":1176,"t":"• Optional _embed: boolean The _embed param returned associated entities in the response It's recommended to avoid additional requests to fetch data Inherited from​ EndpointParams._embed Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:17","s":"_embed","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#_embed","p":1170},{"i":1178,"t":"• Optional _fields: string[] The _fields parameter is used to return only the specified fields in the response Inherited from​ EndpointParams._fields Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:22","s":"_fields","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#_fields","p":1170},{"i":1180,"t":"• Optional author: string | number | number[] Limit result set to posts assigned to specific authors. Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:83","s":"author","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#author","p":1170},{"i":1182,"t":"• Optional author_exclude: number | number[] Ensure result set excludes posts assigned to specific authors. Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:88","s":"author_exclude","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#author_exclude","p":1170},{"i":1184,"t":"• Optional categories: string | number | string[] | number[] Limit result set to all items that have the specified term assigned in the categories taxonomy. Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:156","s":"categories","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#categories","p":1170},{"i":1186,"t":"• Optional categories_exclude: number | number[] Limit result set to all items except those that have the specified term assigned in the categories taxonomy. Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:161","s":"categories_exclude","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#categories_exclude","p":1170},{"i":1188,"t":"• Optional category: string | number | number[] If set will filter results by the specified category name It supports both a category id and category slug Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:44","s":"category","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#category","p":1170},{"i":1190,"t":"• Optional day: string If set will filter results by the specified day Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:66","s":"day","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#day","p":1170},{"i":1192,"t":"• Optional exclude: number[] Ensure result set excludes specific IDs. Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:93","s":"exclude","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#exclude","p":1170},{"i":1194,"t":"• Optional include: number[] Limit result set to specific IDs. Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:98","s":"include","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#include","p":1170},{"i":1196,"t":"• Optional lang: string The polylang ?lang parameter. This is only used if the polylang integration is enabled Inherited from​ EndpointParams.lang Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:29","s":"lang","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#lang","p":1170},{"i":1198,"t":"• Optional matchArchivePath: boolean Overrides the value set in CustomTaxonomy#matchArchivePath Default false Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:190","s":"matchArchivePath","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#matcharchivepath","p":1170},{"i":1200,"t":"• Optional month: string If set will filter results by the specified month Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:61","s":"month","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#month","p":1170},{"i":1202,"t":"• Optional offset: number Offset the result set by a specific number of items. Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:103","s":"offset","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#offset","p":1170},{"i":1204,"t":"• Optional order: \"asc\" | \"desc\" Order sort attribute ascending or descending. Default 'desc' Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:110","s":"order","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#order","p":1170},{"i":1206,"t":"• Optional orderby: \"slug\" | \"date\" | \"modified\" | \"id\" | \"title\" | \"author\" | \"parent\" | \"include\" | \"relevance\" | \"include_slugs\" Sort collection by object attribute. Default 'date' Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:129","s":"orderby","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#orderby","p":1170},{"i":1208,"t":"• Optional page: number Current page of the collection. Default 1 Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:37","s":"page","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#page","p":1170},{"i":1210,"t":"• Optional per_page: number Maximum number of items to be returned in result set. Default 10 Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:73","s":"per_page","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#per_page","p":1170},{"i":1212,"t":"• Optional postType: string The post type to query for. Default 'post' Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:117","s":"postType","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#posttype","p":1170},{"i":1214,"t":"• Optional search: string Limit results to those matching a string. Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:78","s":"search","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#search","p":1170},{"i":1216,"t":"• Optional slug: string | string[] Limit result set to posts with one or more specific slugs. Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:122","s":"slug","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#slug","p":1170},{"i":1218,"t":"• Optional status: string | string[] Limit result set to posts assigned one or more statuses. Default 'publish' Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:146","s":"status","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#status","p":1170},{"i":1220,"t":"• Optional sticky: boolean Limit result set to items that are sticky. Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:183","s":"sticky","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#sticky","p":1170},{"i":1222,"t":"• Optional tag: string | number If set will filter results by the specified tag name It supports both a category id and category slug Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:51","s":"tag","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#tag","p":1170},{"i":1224,"t":"• Optional tags: string | number | string[] | number[] Limit result set to all items that have the specified term assigned in the tags taxonomy. Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:173","s":"tags","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#tags","p":1170},{"i":1226,"t":"• Optional tags_exclude: number | number[] Limit result set to all items except those that have the specified term assigned in the tags taxonomy. Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:178","s":"tags_exclude","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#tags_exclude","p":1170},{"i":1228,"t":"• Optional tax_relation: \"AND\" | \"OR\" Limit result set based on relationship between multiple taxonomies. Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:151","s":"tax_relation","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#tax_relation","p":1170},{"i":1230,"t":"• Optional taxonomy: string Limit results to a specific taxonomy and expects the actual term slug to come from the url] If you only specify the taxonomy, the term slug will be assumed to be the first segment of the path Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:168","s":"taxonomy","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#taxonomy","p":1170},{"i":1232,"t":"• Optional year: string If set will filter results by the specified year Defined in​ packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:56","s":"year","u":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","h":"#year","p":1170},{"i":1234,"t":"@headstartwp/core.PostOrPostsParams The params supported by PostOrPostsFetchStrategy","s":"Interface: PostOrPostsParams","u":"/docs/api/interfaces/headstartwp_core.PostOrPostsParams/","h":"","p":1233},{"i":1236,"t":"EndpointParams ↳ PostOrPostsParams","s":"Hierarchy","u":"/docs/api/interfaces/headstartwp_core.PostOrPostsParams/","h":"#hierarchy","p":1233},{"i":1239,"t":"• Optional _embed: boolean The _embed param returned associated entities in the response It's recommended to avoid additional requests to fetch data Inherited from​ EndpointParams._embed Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:17","s":"_embed","u":"/docs/api/interfaces/headstartwp_core.PostOrPostsParams/","h":"#_embed","p":1233},{"i":1241,"t":"• Optional _fields: string[] The _fields parameter is used to return only the specified fields in the response Inherited from​ EndpointParams._fields Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:22","s":"_fields","u":"/docs/api/interfaces/headstartwp_core.PostOrPostsParams/","h":"#_fields","p":1233},{"i":1243,"t":"• archive: Partial The archive params corresponds to PostsArchiveParams Defined in​ packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:25","s":"archive","u":"/docs/api/interfaces/headstartwp_core.PostOrPostsParams/","h":"#archive","p":1233},{"i":1245,"t":"• Optional lang: string The polylang ?lang parameter. This is only used if the polylang integration is enabled Inherited from​ EndpointParams.lang Defined in​ packages/core/src/data/strategies/AbstractFetchStrategy.ts:29","s":"lang","u":"/docs/api/interfaces/headstartwp_core.PostOrPostsParams/","h":"#lang","p":1233},{"i":1247,"t":"• priority: \"archive\" | \"single\" The priority indicates which strategy should execute first. Defined in​ packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:30","s":"priority","u":"/docs/api/interfaces/headstartwp_core.PostOrPostsParams/","h":"#priority","p":1233},{"i":1249,"t":"• routeMatchStrategy: \"none\" | \"archive\" | \"single\" | \"both\" How to handle route matching strategy, the possible values are: single will only trigger the single strategy if there's a url match for the single strategy archive will only trigger the archive strategy if there's a url match for the archive strategy both requires a route match for both single and archive Defined in​ packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:39","s":"routeMatchStrategy","u":"/docs/api/interfaces/headstartwp_core.PostOrPostsParams/","h":"#routematchstrategy","p":1233},{"i":1251,"t":"• single: Partial The single params corresponds to PostParams Defined in​ packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:20","s":"single","u":"/docs/api/interfaces/headstartwp_core.PostOrPostsParams/","h":"#single","p":1233},{"i":1253,"t":"@headstartwp/core.react.AudioBlockProps The interface for components rendered by AudioBlock","s":"Interface: AudioBlockProps","u":"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps/","h":"","p":1252},{"i":1255,"t":"IBlockAttributes ↳ AudioBlockProps","s":"Hierarchy","u":"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps/","h":"#hierarchy","p":1252},{"i":1258,"t":"• Optional attributes: Object Type declaration​ Name Type align Align blockStyle? string border Border colors Colors spacing Spacing typography Typography width? string Inherited from​ IBlockAttributes.attributes Defined in​ packages/core/src/react/blocks/types.ts:79","s":"attributes","u":"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps/","h":"#attributes","p":1252},{"i":1260,"t":"• Optional autoplay: boolean Whether the audio should be autoplayable Defined in​ packages/core/src/react/blocks/AudioBlock.tsx:19","s":"autoplay","u":"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps/","h":"#autoplay","p":1252},{"i":1262,"t":"• Optional caption: string Audio caption Defined in​ packages/core/src/react/blocks/AudioBlock.tsx:24","s":"caption","u":"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps/","h":"#caption","p":1252},{"i":1264,"t":"• Optional children: ReactNode Inherited from​ IBlockAttributes.children Defined in​ packages/core/src/react/blocks/types.ts:77","s":"children","u":"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps/","h":"#children","p":1252},{"i":1266,"t":"• Optional className: string Inherited from​ IBlockAttributes.className Defined in​ packages/core/src/react/blocks/types.ts:73","s":"className","u":"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps/","h":"#classname","p":1252},{"i":1268,"t":"• Optional domNode: Element Inherited from​ IBlockAttributes.domNode Defined in​ packages/core/src/react/blocks/types.ts:75","s":"domNode","u":"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps/","h":"#domnode","p":1252},{"i":1270,"t":"• Optional htmlAnchor: string Inherited from​ IBlockAttributes.htmlAnchor Defined in​ packages/core/src/react/blocks/types.ts:76","s":"htmlAnchor","u":"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps/","h":"#htmlanchor","p":1252},{"i":1272,"t":"• Optional loop: boolean Whether the audio should be played in a loop Defined in​ packages/core/src/react/blocks/AudioBlock.tsx:29","s":"loop","u":"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps/","h":"#loop","p":1252},{"i":1274,"t":"• name: string Inherited from​ IBlockAttributes.name Defined in​ packages/core/src/react/blocks/types.ts:72","s":"name","u":"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps/","h":"#name","p":1252},{"i":1276,"t":"• Optional preload: string Whether to preload the audio or not Defined in​ packages/core/src/react/blocks/AudioBlock.tsx:34","s":"preload","u":"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps/","h":"#preload","p":1252},{"i":1278,"t":"• src: string The audio source URL. Defined in​ packages/core/src/react/blocks/AudioBlock.tsx:14","s":"src","u":"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps/","h":"#src","p":1252},{"i":1280,"t":"• Optional style: Record Inherited from​ IBlockAttributes.style Defined in​ packages/core/src/react/blocks/types.ts:74","s":"style","u":"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps/","h":"#style","p":1252},{"i":1282,"t":"@headstartwp/core.react.BlockAttributes","s":"Interface: BlockAttributes","u":"/docs/api/interfaces/headstartwp_core.react.BlockAttributes/","h":"","p":1281},{"i":1284,"t":"Colors ↳ BlockAttributes","s":"Hierarchy","u":"/docs/api/interfaces/headstartwp_core.react.BlockAttributes/","h":"#hierarchy","p":1281},{"i":1287,"t":"• align: Align Defined in​ packages/core/src/react/blocks/types.ts:95","s":"align","u":"/docs/api/interfaces/headstartwp_core.react.BlockAttributes/","h":"#align","p":1281},{"i":1289,"t":"• backgroundColor: string Inherited from​ Colors.backgroundColor Defined in​ packages/core/src/react/blocks/types.ts:6","s":"backgroundColor","u":"/docs/api/interfaces/headstartwp_core.react.BlockAttributes/","h":"#backgroundcolor","p":1281},{"i":1291,"t":"• backgroundColorSlug: string Inherited from​ Colors.backgroundColorSlug Defined in​ packages/core/src/react/blocks/types.ts:5","s":"backgroundColorSlug","u":"/docs/api/interfaces/headstartwp_core.react.BlockAttributes/","h":"#backgroundcolorslug","p":1281},{"i":1293,"t":"• gradient: string Inherited from​ Colors.gradient Defined in​ packages/core/src/react/blocks/types.ts:8","s":"gradient","u":"/docs/api/interfaces/headstartwp_core.react.BlockAttributes/","h":"#gradient","p":1281},{"i":1295,"t":"• gradientSlug: string Inherited from​ Colors.gradientSlug Defined in​ packages/core/src/react/blocks/types.ts:7","s":"gradientSlug","u":"/docs/api/interfaces/headstartwp_core.react.BlockAttributes/","h":"#gradientslug","p":1281},{"i":1297,"t":"• linkColor: string Inherited from​ Colors.linkColor Defined in​ packages/core/src/react/blocks/types.ts:12","s":"linkColor","u":"/docs/api/interfaces/headstartwp_core.react.BlockAttributes/","h":"#linkcolor","p":1281},{"i":1299,"t":"• linkColorSlug: string Inherited from​ Colors.linkColorSlug Defined in​ packages/core/src/react/blocks/types.ts:11","s":"linkColorSlug","u":"/docs/api/interfaces/headstartwp_core.react.BlockAttributes/","h":"#linkcolorslug","p":1281},{"i":1301,"t":"• style: Partial