@markmap/render 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Gerald
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,5 @@
-# Temporary Holding Version
+# @markmap/render
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Measure, lay out and render Markmap trees to primitives and SVG.
+
+See the [Markmap README](https://github.com/markmap/markmap#readme) for how the packages fit together.

package/dist/animate.d.ts

@@ -0,0 +1,12 @@
+import { type FrameNode, type InterpolateContext, type Layout, type LayoutFrame, type Theme } from '@markmap/core';
+import type { DrawState } from './render';
+export type Easing = (t: number) => number;
+export declare const easeCubicInOut: Easing;
+/**
+ * The default {@link Layout.interpolate}: nodes in both frames move in a straight line;
+ * entering nodes grow out of their nearest ancestor's anchor (on the side they grow
+ * towards) and leaving nodes shrink back into their nearest surviving ancestor's.
+ */
+export declare function interpolateFrames<N extends FrameNode>(from: LayoutFrame<N>, to: LayoutFrame<N>, t: number, ctx: InterpolateContext<N>): LayoutFrame<N>;
+/** Interpolate draw states with the layout's own interpolation, or the default one. */
+export declare function interpolateStates(from: DrawState, to: DrawState, t: number, theme: Theme, layout?: Layout): DrawState;

package/dist/content.d.ts

@@ -0,0 +1,10 @@
+import type { ContentPlugin } from '@markmap/core';
+/** Keep http(s), mailto, tel and relative URLs. Anything else, such as `javascript:`, is dropped. */
+export declare function sanitizeUrl(url: string): string | undefined;
+/** Bold, italic, inline code, links, strikethrough, highlight and task checkboxes. */
+export declare const basicContent: ContentPlugin;
+/**
+ * Adds a dot after the label of nodes with notes, with a hit area that asks the
+ * view to open them. The dot is exported; the hit area is interactive-only.
+ */
+export declare const noteContent: ContentPlugin;

package/dist/default-plugins.d.ts

@@ -0,0 +1,3 @@
+import type { ContentPlugin } from '@markmap/core';
+/** Plugins used when none are given: basic styles, images, and note dots. */
+export declare const defaultContentPlugins: readonly ContentPlugin[];

package/dist/image.d.ts

@@ -0,0 +1,23 @@
+import type { ContentPlugin, Size } from '@markmap/core';
+export interface ImageContentOptions {
+    /**
+     * Find an image's natural size. Defaults to loading it with `Image` where that exists
+     * (browsers); elsewhere unsized images keep their placeholder size.
+     */
+    loadSize?: (src: string) => Promise<Size>;
+    /** Return `false` to show an image's alt text instead, e.g. to block remote images. */
+    allow?: (src: string) => boolean;
+    /** Width cap when labels do not wrap, in px. With wrapping, `wrapWidth` caps images too. */
+    maxWidth?: number;
+}
+/** Like {@link sanitizeUrl}, plus base64 raster `data:` images. */
+export declare function sanitizeImageUrl(url: string): string | undefined;
+/**
+ * Draws Markdown images and sized `<img>` tags inside labels. Sizes come from the tag,
+ * from a cache of loaded sizes, or from a placeholder while the image loads; the view
+ * then renders again (see `InlineContext.defer`). Images are capped at the label wrap
+ * width, keeping their aspect ratio. Images that fail to load show their alt text.
+ */
+export declare function createImageContent(options?: ImageContentOptions): ContentPlugin;
+/** Images with sizes loaded in the browser. */
+export declare const imageContent: ContentPlugin;

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+export * from './content';
+export * from './default-plugins';
+export * from './image';
+export * from './layouts';
+export * from './measure';
+export * from './options';
+export * from './paint';
+export * from './render';
+export * from './svg';
+export * from './text';
+export * from './themes/branch';
+export * from './themes/cards';
+export * from './themes/classic';
+export * from './themes/minimal';
+export * from './animate';