Skip to content

Commit 17f6736

Browse files
committed
refactor: rename getSliceZoneComponents() to defineSliceZoneComponents()
1 parent 0bc4f29 commit 17f6736

File tree

4 files changed

+17
-17
lines changed

4 files changed

+17
-17
lines changed

src/components/SliceZone.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -254,11 +254,11 @@ export type SliceZoneComponents<
254254
* @example Defining a slice components:
255255
*
256256
* ```javascript
257-
* import { getSliceZoneComponents } from "@prismicio/vue";
257+
* import { defineSliceZoneComponents } from "@prismicio/vue";
258258
*
259259
* export default {
260260
* data() {
261-
* components: getSliceZoneComponents({
261+
* components: defineSliceZoneComponents({
262262
* foo: Foo,
263263
* bar: defineAsyncComponent(
264264
* () => new Promise((res) => res(Bar)),
@@ -275,7 +275,7 @@ export type SliceZoneComponents<
275275
*
276276
* @returns A new optimized record of {@link SliceZoneComponents}
277277
*/
278-
export const getSliceZoneComponents = <
278+
export const defineSliceZoneComponents = <
279279
TSlice extends SliceLike = SliceLike,
280280
TContext = unknown,
281281
>(

src/components/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export type {
2323
export {
2424
getSliceComponentProps,
2525
TODOSliceComponent,
26-
getSliceZoneComponents,
26+
defineSliceZoneComponents,
2727
SliceZoneImpl,
2828
SliceZone,
2929
} from "./SliceZone";

src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export {
1515
// Slice Zone
1616
getSliceComponentProps,
1717
TODOSliceComponent,
18-
getSliceZoneComponents,
18+
defineSliceZoneComponents,
1919
SliceZoneImpl,
2020
SliceZone,
2121
} from "./components";

test/components-SliceZone.test.ts

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import {
1010
} from "./__fixtures__/WrapperComponent";
1111

1212
import {
13-
getSliceZoneComponents,
13+
defineSliceZoneComponents,
1414
SliceComponentType,
1515
SliceZoneImpl,
1616
SliceZoneResolver,
@@ -44,7 +44,7 @@ test("renders slice zone with correct component mapping from components", async
4444
{ slice_type: "bar" },
4545
{ slice_type: "baz" },
4646
],
47-
components: getSliceZoneComponents({
47+
components: defineSliceZoneComponents({
4848
foo: Foo,
4949
bar: defineAsyncComponent(
5050
() => new Promise<SliceComponentType>((res) => res(Bar)),
@@ -91,7 +91,7 @@ test("renders slice zone with correct component mapping from resolver", async (t
9191
{ slice_type: "baz" },
9292
],
9393
resolver: (({ sliceName }) => {
94-
const components = getSliceZoneComponents({
94+
const components = defineSliceZoneComponents({
9595
foo: Foo,
9696
bar: defineAsyncComponent(
9797
() => new Promise<SliceComponentType>((res) => res(Bar)),
@@ -134,7 +134,7 @@ test("provides context to each slice", (t) => {
134134
const wrapper = mount(SliceZoneImpl, {
135135
props: {
136136
slices: [{ slice_type: "foo" }, { slice_type: "bar" }],
137-
components: getSliceZoneComponents({
137+
components: defineSliceZoneComponents({
138138
foo: Foo,
139139
bar: Bar,
140140
}),
@@ -157,7 +157,7 @@ test("renders TODO component if component mapping is missing", (t) => {
157157
const wrapper = mount(SliceZoneImpl, {
158158
props: {
159159
slices: [{ slice_type: "foo" }, { slice_type: "bar" }],
160-
components: getSliceZoneComponents({
160+
components: defineSliceZoneComponents({
161161
foo: Foo,
162162
}),
163163
},
@@ -196,7 +196,7 @@ test("renders plugin provided TODO component if component mapping is missing", (
196196
const wrapper = mount(SliceZoneImpl, {
197197
props: {
198198
slices: [{ slice_type: "foo" }, { slice_type: "bar" }],
199-
components: getSliceZoneComponents({
199+
components: defineSliceZoneComponents({
200200
foo: Foo,
201201
}),
202202
},
@@ -234,7 +234,7 @@ test("renders provided TODO component over plugin provided if component mapping
234234
const wrapper = mount(SliceZoneImpl, {
235235
props: {
236236
slices: [{ slice_type: "foo" }, { slice_type: "bar" }],
237-
components: getSliceZoneComponents({
237+
components: defineSliceZoneComponents({
238238
foo: Foo,
239239
}),
240240
defaultComponent: markRaw(Baz),
@@ -270,7 +270,7 @@ test("wraps output with provided wrapper tag", (t) => {
270270
const wrapper = mount(SliceZoneImpl, {
271271
props: {
272272
slices: [{ slice_type: "foo" }, { slice_type: "bar" }],
273-
components: getSliceZoneComponents({
273+
components: defineSliceZoneComponents({
274274
foo: Foo,
275275
bar: Bar,
276276
}),
@@ -300,7 +300,7 @@ test("wraps output with provided wrapper component", (t) => {
300300
const wrapper = mount(SliceZoneImpl, {
301301
props: {
302302
slices: [{ slice_type: "foo" }, { slice_type: "bar" }],
303-
components: getSliceZoneComponents({
303+
components: defineSliceZoneComponents({
304304
foo: Foo,
305305
bar: Bar,
306306
}),
@@ -323,7 +323,7 @@ test("renders nothing when invalid", (t) => {
323323
const wrapper = mount(SliceZoneImpl, {
324324
props: {
325325
slices: null as unknown as SliceZoneLike<SliceLike>,
326-
components: getSliceZoneComponents({}),
326+
components: defineSliceZoneComponents({}),
327327
},
328328
});
329329

@@ -352,7 +352,7 @@ test("reacts to changes properly", async (t) => {
352352
const wrapper = mount(SliceZoneImpl, {
353353
props: {
354354
slices: [{ slice_type: "foo" }, { slice_type: "bar" }],
355-
components: getSliceZoneComponents({
355+
components: defineSliceZoneComponents({
356356
foo: Foo,
357357
bar: Bar,
358358
}),
@@ -363,7 +363,7 @@ test("reacts to changes properly", async (t) => {
363363

364364
await wrapper.setProps({
365365
slices: [{ slice_type: "bar" }],
366-
components: getSliceZoneComponents({
366+
components: defineSliceZoneComponents({
367367
foo: Foo,
368368
bar: Bar,
369369
}),

0 commit comments

Comments
 (0)