Builder.io
Builder.io - это визуальная Headless CMS. Представьте CMS, которая интегрируется в существующую кодовую базу Qwik, позволяя вам и вашей команде редактировать контент без необходимости писать код.
Настройка
Вы можете легко добавить builder.io с помощью следующей команды:
npm run qwik add builder.io
После выполнения вышеприведённой команды будет установлен пакет @builder.io/sdk-qwik
, а также будут созданы новый образец компонента и маршрут по умолчанию в src/components
и src/routes
соответственно.
Создайте бесплатный аккаунт Builder.io (это займёт всего пару минут) и вставьте свой открытый ключ API в .env
.
- BUILDER_PUBLIC_API_KEY=YOUR_API_KEY
+ BUILDER_PUBLIC_API_KEY=abc123
Затем запустите сервер разработки:
npm run dev
Теперь перейдите по вашему URL для предварительного просмотра на http://localhost:5173/
.
- Перейдите на https://builder.io/models
- Выберите модель
page
- Установите URL для предварительного просмотра на
http://localhost:5173/
и нажмитесохранить
в правом верхнем углу.
Теперь давайте создадим страницу в Builder.io и увидим её вживую в Qwik!
- Перейдите на https://builder.io/content
- Клик на
+ New
и выберитеPage
- Дайте странице имя и нажмите
Create
.
Теперь опробуйте визуальный редактор! Пользовательские компоненты Qwik можно найти в разделе Custom Components
на вкладке вставки.
Вы также можете ограничить визуальное редактирование только вашими пользовательскими компонентами с помощью components-only mode.
Регистрация своих компонентов
Одной из главных особенностей визуальной Headless CMS является то, что вы можете предоставить свои компоненты для CMS, т.е. ваши компоненты Qwik могут быть использованы как блоки в Builder.io.
import { MyFunComponent } from './fun/fun';
export const CUSTOM_COMPONENTS: RegisteredComponent[] = [
{
component: MyFunComponent,
name: 'MyFunComponent',
inputs: [
{
name: 'text',
type: 'string',
defaultValue: 'Hello world',
},
],
},
];
export default component$(() => {
const content = useBuilderContent();
return (
<RenderContent
customComponents={CUSTOM_COMPONENTS}
/>
);
});
Следующие шаги
Смотрите наши полные руководства по интеграции здесь.
Кроме того, когда вы запустите интеграцию в производственной среде, вернитесь и обновите URL для предварительного просмотра на URL для производственной среды, чтобы теперь любой член вашей команды мог визуально создавать контент в вашем приложении Qwik!
Также для интеграции структурированных данных см. это руководство.