PHPackages                             cms-orbit/popup - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [PDF & Document Generation](/categories/documents)
4. /
5. cms-orbit/popup

ActiveLibrary[PDF & Document Generation](/categories/documents)

cms-orbit/popup
===============

CMS Orbit popup: document-based popup content type for the Orbit admin engine.

4.0.2(1mo ago)03MITPHP ^8.3

Since Jul 5Compare

[ Source](https://github.com/cms-orbit/popup)[ Packagist](https://packagist.org/packages/cms-orbit/popup)[ RSS](/packages/cms-orbit-popup/feed)WikiDiscussions Synced 1w ago

READMEChangelogDependencies (6)Versions (4)Used By (0)

CMS Orbit Popup
===============

[](#cms-orbit-popup)

`cms-orbit/popup`은 Orbit 문서 엔진 위에 구축된 팝업 패키지입니다.
관리자에서는 팝업 콘텐츠를 문서처럼 관리하고, 프런트에서는 활성 팝업만 골라 오버레이로 띄울 수 있습니다.

주요 기능
-----

[](#주요-기능)

- `cms-orbit/core` 기반 문서형 팝업 콘텐츠
- Orbit 관리자 CRUD 자동 등록
- 노출 기간(`started_at`, `ended_at`) 관리
- "오늘 하루 보지 않기"를 위한 `ignore_days` 지원
- 스타일 JSON(`styles`) 기반 오버레이 커스터마이징
- 활성 팝업 조회 API와 `OrbitPopups` React 컴포넌트 제공

설치
--

[](#설치)

```
composer require cms-orbit/popup:^4.0
php artisan migrate
php artisan orbit:frontend-sync   # orbit:install 직후라면 생략 가능
npm run dev                       # OrbitPopups 컴포넌트 개발 시
```

`cms-orbit/core`가 먼저 설치·설정(`orbit:install`)되어 있어야 합니다.

Laravel Boost
-------------

[](#laravel-boost)

이 패키지는 `resources/boost/guidelines/popup.md`, `resources/boost/skills/popup-development/`를 제공합니다.

- Boost **최초 설정**: 호스트에서 `php artisan boost:install` 1회
- **이후**: `orbit:install` / `orbit:sync`가 이 패키지를 Boost에 등록하고 `boost:update` 실행 (Boost가 이미 설정된 경우)

호스트 설정
------

[](#호스트-설정)

작업필수 여부`composer require cms-orbit/popup` + `php artisan migrate`**필수**`php artisan orbit:frontend-sync`**필수** (`@cms-orbit/popup` alias)레이아웃에 `` 1회 렌더**필수** (어느 공개 레이아웃에 띄울지는 호스트가 선택)API 라우트 수동 등록**불필요**빠른 시작
-----

[](#빠른-시작)

### 1. 관리자에서 팝업 작성

[](#1-관리자에서-팝업-작성)

관리자 화면에서 제목, 본문, 노출 시작/종료 시각, 다시 보지 않기 일수, 타이틀 노출 여부, 스타일 JSON을 관리할 수 있습니다.

### 2. 레이아웃에 오버레이 연결

[](#2-레이아웃에-오버레이-연결)

호스트 레이아웃에 `OrbitPopups`를 한 번만 렌더링하면, 현재 시각 기준으로 활성 상태인 팝업을 자동 조회해 표시합니다.

```
import { OrbitPopups } from '@cms-orbit/popup';

export function AppShell() {
    return (

    );
}
```

기본 조회 엔드포인트는 `/popups/active`이며, 필요하면 `endpoint` prop으로 바꿀 수 있습니다.

```

```

공개 엔드포인트
--------

[](#공개-엔드포인트)

- `popups.active`

기본 경로:

```
/popups/active

```

운영 팁
----

[](#운영-팁)

- `ignore_days`가 0 이하이면 세션 단위로만 닫힘 상태를 기억합니다.
- `ignore_days`가 1 이상이면 `localStorage`에 만료 시각을 저장해 "오늘 하루 보지 않기" 흐름을 구현합니다.
- `styles`에는 폭, 위치, 여백 같은 오버레이 스타일 값을 JSON으로 넣어 개별 팝업을 손쉽게 조정할 수 있습니다.

License
-------

[](#license)

MIT

###  Health Score

39

—

LowBetter than 84% of packages

Maintenance91

Actively maintained with recent releases

Popularity3

Limited adoption so far

Community2

Small or concentrated contributor base

Maturity51

Maturing project, gaining track record

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~4 days

Total

3

Last Release

42d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/3d4228d7eaafb1a5b13e853f87189815feefd9c21f31363d08ec509c47f29d0a?d=identicon)[cms-orbit](/maintainers/cms-orbit)

---

Tags

laravelcmspopupdocumentorbit

###  Code Quality

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/cms-orbit-popup/health.svg)

```
[![Health](https://phpackages.com/badges/cms-orbit-popup/health.svg)](https://phpackages.com/packages/cms-orbit-popup)
```

###  Alternatives

[statamic/cms

The Statamic CMS Core Package

4.9k3.8M1.2k](/packages/statamic-cms)[typicms/base

A modular multilingual CMS built with Laravel, enabling developers to manage structured content like pages, news, events, and more.

1.6k20.4k](/packages/typicms-base)[statamic/statamic

Statamic

832182.1k](/packages/statamic-statamic)[nasirkhan/laravel-starter

A CMS like modular Laravel starter project.

1.4k2.7k](/packages/nasirkhan-laravel-starter)[api-platform/laravel

API Platform support for Laravel

58190.1k21](/packages/api-platform-laravel)[ecotone/laravel

Ecotone for Laravel — CQRS, Event Sourcing, Sagas, Durable Workflows, and Outbox on top of Laravel Queue, via PHP attributes.

21327.3k4](/packages/ecotone-laravel)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)