Перейти к содержимому
FastOffice

Свой пункт меню

Чужой пункт в нашем меню: за чертой, под именем владельца и со своей командой — притвориться нашим он не может.

чужой пункт в нашем меню: за чертой, под именем владельца и со своей командой — притвориться нашим он не может
открыть в новой вкладке ↗Работающий пример. Ниже — его код целиком, файл за файлом.

В рамке выше работает тот самый проект, чей код лежит ниже, — собранный, но не переписанный: те же файлы, только пропущенные через сборку. Считает в нём не ядро, а дублёр транспорта, поэтому числа в ячейках ничего не значат: смотреть нужно на код.

Страница, которую открывает браузер.

index.html
<!doctype html>
<!--
Свой пункт меню — НАСТОЯЩИЙ МАЛЕНЬКИЙ ПРОЕКТ.
Не «страница витрины», а тот проект, который встраивающий копирует к себе
целиком. Галерея примеров ЗАПУСКАЕТ эти файлы и ПОКАЗЫВАЕТ их же.
-->
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Свой пункт меню — @f1</title>
</head>
<body>
<div data-example="custom-menu" class="flex h-screen w-screen flex-col bg-base-100 text-base-content">
<header class="border-b border-base-300 px-4 py-2">
<div class="text-sm font-semibold">Свой пункт меню</div>
<div class="text-xs opacity-70">
Щелчок правой кнопкой по ячейке: наши пункты идут из реестра, чужие — хвостом, за чертой и под
именем владельца. Команду чужому пункту собрали мы, поэтому назваться нашим он не может.
</div>
</header>
<div id="app" class="flex min-h-0 flex-1 flex-col"></div>
<footer class="border-t border-base-300 px-4 py-2 font-mono text-xs" data-ext-log>
<span class="opacity-60">шина молчит — нажмите что-нибудь</span>
</footer>
</div>
<script type="module" src="./src/main.ts"></script>
</body>
</html>

Точка входа: здесь лист создаётся и сюда же приходят события.

src/main.ts
import { createSheetsCore } from "@f1/preset-sheets-core";
import { defineExtension } from "@f1/extend";
import { transport } from "./book.js";
import { hostAsks } from "./host.js";
import "./styles.css";
/**
* СВОЙ ПУНКТ МЕНЮ — И ГРАНИЦА, КОТОРУЮ ОН ОБЯЗАН УВАЖАТЬ.
*
* Трудность этой точки расширения не в том, чтобы пункт появился, а в том,
* чтобы на одной поверхности ужились две правды. Наши пункты приходят из
* реестра f1 (инвариант №4); команды встраивающего в реестре не будет никогда.
*
* Поэтому граница видна глазами: чужой пункт стоит ХВОСТОМ, за чертой и под
* именем владельца, а команду ему собрали МЫ (`ext.acme.…`) — назваться
* `clipboard.copy` он не в состоянии. Журнал под листом показывает, что уехало
* на шину, вместе с приставкой.
*
* Второй пункт объявлен СЕРЫМ, и серым его сделал хозяин СВОИМИ словами: о
* чужом коде мы не знаем ничего, и наше «не подключено» здесь было бы неправдой.
*/
const { locale } = hostAsks();
const log = document.querySelector("[data-ext-log]")!;
const lines: string[] = [];
function say(line: string): void {
lines.push(line);
log.textContent = lines.slice(-7).join("\n");
}
const core = createSheetsCore({
mount: document.getElementById("app")!,
transport,
locale,
extend: defineExtension({
owner: "acme",
title: "Acme",
items: [
{
menu: "cell-context",
id: "send",
label: "Отправить в Acme",
run: () => say("Acme: ячейка отправлена"),
},
{
menu: "cell-context",
id: "history",
label: "История в Acme",
run: () => say("Acme: история"),
/* Нечего делать — и это сказано ЕГО словами, а не нашими. */
disabled: "Нужен вход в Acme",
},
],
}),
/* Шина наружу: сюда приходят и наши команды, и его. */
onCommand: (command) => say(command),
});
import.meta.hot?.dispose(() => core.destroy());

Книга примера: данные, с которыми лист открывается.

src/book.ts
import { createMockTransport } from "@f1/contract";
/**
* КНИГА-ЗАГЛУШКА — ВМЕСТО НАСТОЯЩЕГО ЯДРА.
*
* Транспорт контракта — единственное место, где лист разговаривает с ядром
* (инвариант №1: считает ядро, оболочка только показывает). В продукте здесь
* стоит `wasm` или мост хоста, и меняется РОВНО эта строка — всё остальное в
* проекте остаётся как есть.
*/
export const transport = createMockTransport({
cellAt: (row, col) => (col === 0 ? `строка ${row + 1}` : `${(row + 1) * (col + 1)}`),
});

Сторона хозяина страницы: что приложение отвечает листу и что от него получает.

src/host.ts
import { applyLocaleAttributes, resolveLocale, setLocale, type Locale } from "@f1/i18n";
/**
* ЧТО ХОЗЯИН СТРАНИЦЫ ДАЁТ ЛИСТУ — тема и язык.
*
* У встраивающего это уже есть своё: тему он знает из настроек, язык — из
* профиля пользователя. Здесь и то и другое читается из адреса
* (`?theme=dark&locale=ar`) ровно затем, чтобы на любое состояние можно было
* дать ссылку и чтобы его проверял обход: настройка, доступная только щелчком,
* недоступна ни ссылке, ни автоматической проверке.
*
* ПРИЗНАКИ СТАВЯТСЯ НА КОРЕНЬ ДОКУМЕНТА — потому что это делает ХОЗЯИН, а не
* лист. Лист читает тему оттуда, где стоит (`:host-context`), а язык получает
* СВОЙСТВОМ сборки: два листа на одной странице вправе говорить на разном.
*
* НАПРАВЛЕНИЕ ПИСЬМА — ИНТЕРФЕЙСА, А НЕ ДОКУМЕНТА. `dir="rtl"` зеркалит хром
* страницы; «Лист справа налево» из Excel — свойство КНИГИ, и сетка от
* арабского языка интерфейса не переворачивается. Это не пропуск, а решение
* (`locale.ts`).
*/
export function hostAsks(): { readonly theme: "light" | "dark"; readonly locale: Locale } {
const params = new URLSearchParams(location.search);
const theme = params.get("theme") === "dark" ? "dark" : "light";
const locale = resolveLocale(params.get("locale") ?? undefined, "ru");
document.documentElement.setAttribute("data-theme", theme);
/* Язык — один на процесс: словарь модульный, и ставит его хозяин страницы. */
setLocale(locale);
applyLocaleAttributes(document.documentElement, locale);
return { theme, locale };
}

Оформление страницы вокруг листа.

src/styles.css
/* ЛИСТ СТИЛЕЙ НАБОРА КОМПОНЕНТОВ — ЕДИНСТВЕННАЯ СТРОКА, КОТОРУЮ НЕЛЬЗЯ ЗАБЫТЬ.
Собственное оформление лист приносит в теневые корни сам, но утилиты
раскладки, которыми он держит свои органы, компилируются ЭТИМ листом. Без
него страница не просто выглядит иначе — вкладка ЗАВИСАЕТ (бесконечный цикл
замера у сетки без размеров). У потребителя вне репозитория это
`@fastoffices/formula-kit` из его node_modules. */
@import "@fastoffices/formula-kit"; /* см. примечание выше */
html,
body {
height: 100%;
margin: 0;
}

Из каких пакетов собран пример.

package.json
{
"name": "f1-example-custom-menu",
"private": true,
"type": "module",
"description": "Чужой пункт в нашем меню: за чертой, под именем владельца и со СВОЕЙ командой.",
"scripts": {
"dev": "vite",
"build": "vite build"
},
"dependencies": {
"@f1/preset-sheets-core": "*",
"@f1/contract": "*",
"@f1/extend": "*",
"@f1/i18n": "*"
},
"devDependencies": {
"vite": "^7.0.0"
}
}

Ассистент документации

Ответ собран из документации и может быть неточным — сверяйтесь с источниками.