Skip to content

Commit

Permalink
Ported the library to TypeScript.
Browse files Browse the repository at this point in the history
  • Loading branch information
EliteMasterEric committed Mar 17, 2021
1 parent da47b80 commit 5d9da2e
Show file tree
Hide file tree
Showing 6 changed files with 15,581 additions and 1,316 deletions.
2 changes: 1 addition & 1 deletion .babelrc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"presets": ["@babel/env", "@babel/react"]
"presets": ["@babel/env", "@babel/react", "@babel/preset-typescript"]
}
16,658 changes: 15,412 additions & 1,246 deletions package-lock.json

Large diffs are not rendered by default.

10 changes: 7 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@
"version": "2.0.0",
"description": "React wrapper of leaflet-textpath",
"main": "dist/index.js",
"module": "src/index.js",
"module": "src/index.ts",
"scripts": {
"test": "jest",
"cover": "jest --coverage --collectCoverageFrom=src/**/*.js",
"lint": "eslint ./src/**/*.js ./__tests__/**/*.js",
"type-check": "tsc --pretty --noEmit",
"changelog": "auto-changelog -p --tag-prefix v",
"release": "np",
"version": "npm run changelog && git add CHANGELOG.md",
"build": "babel src --out-dir dist",
"build": "babel src --extensions \".ts\" --out-dir dist",
"prepublishOnly": "npm run build"
},
"repository": {
Expand All @@ -37,6 +38,8 @@
"@babel/core": "^7.12.10",
"@babel/preset-env": "^7.12.11",
"@babel/preset-react": "^7.12.10",
"@babel/preset-typescript": "^7.13.0",
"@types/leaflet-textpath": "^1.2.0",
"@wojtekmaj/enzyme-adapter-react-17": "^0.4.1",
"auto-changelog": "^2.2.1",
"babel-core": "^7.0.0-bridge.0",
Expand All @@ -52,7 +55,8 @@
"prettier": "^2.2.1",
"react": "^17.0.1",
"react-dom": "^17.0.1",
"react-leaflet": "^3.0.0"
"react-leaflet": "^3.0.0",
"typescript": "^4.2.3"
},
"peerDependencies": {
"leaflet": "^1.0.0",
Expand Down
66 changes: 0 additions & 66 deletions src/index.js

This file was deleted.

86 changes: 86 additions & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
import { createPathComponent, LeafletContextInterface, PathProps } from '@react-leaflet/core';
import { LatLngExpression, Polyline as LeafletPolyline, TextPathOptions } from 'leaflet';
import 'leaflet-textpath';
import { PropsWithChildren } from 'react';

interface ReactLeafletTextPathBaseProps {
/**
* The text to display over the polyline.
*/
text: string;
/**
* The positions to use for the polyline.
*/
positions: LatLngExpression[];
}
export type ReactLeafletTextPathProps = TextPathOptions &
PathProps &
PropsWithChildren<ReactLeafletTextPathBaseProps>;

const createLeafletElement = (
{
// Required TextPath attributes.
text,
positions,
// TextPath options.
repeat,
center,
below,
offset,
orientation,
attributes,
// PolyLine options.
...options
}: ReactLeafletTextPathProps,
ctx: LeafletContextInterface
) => {
const instance = new LeafletPolyline(positions, options);
instance.setText(text, {
repeat,
center,
below,
offset,
orientation,
attributes,
});
return { instance, context: { ...ctx, overlayContainer: instance } };
};

const updateLeafletElement = (
layer: LeafletPolyline,
{
// Required TextPath attributes.
text,
positions,
// TextPath options.
repeat,
center,
below,
offset,
orientation,
attributes,
// PolyLine options.
...options
}: ReactLeafletTextPathProps,
prevProps: ReactLeafletTextPathProps
) => {
// Set null first, to reset the text displayed.
layer.setText(null);
if (positions !== prevProps.positions) layer.setLatLngs(positions);
layer.setStyle(options);
layer.setText(text, {
repeat,
center,
below,
offset,
orientation,
attributes,
});
};

const ReactLeafletTextPath = createPathComponent<LeafletPolyline, ReactLeafletTextPathProps>(
createLeafletElement,
updateLeafletElement
);

export default ReactLeafletTextPath;
75 changes: 75 additions & 0 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig.json to read more about this file */

/* Basic Options */
// "incremental": true, /* Enable incremental compilation */
"target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
// "lib": [], /* Specify library files to be included in the compilation. */
// "allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
// "declaration": true, /* Generates corresponding '.d.ts' file. */
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
// "sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
// "outDir": "./", /* Redirect output structure to the directory. */
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "composite": true, /* Enable project compilation */
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
// "removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */

/* Strict Type-Checking Options */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */

/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
// "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */

/* Module Resolution Options */
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */

/* Source Map Options */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */

// Ensure that .d.ts files are created by tsc, but not .js files
"declaration": true,
// Ensure that Babel can safely transpile files in the TypeScript project
"isolatedModules": true,

/* Advanced Options */
"skipLibCheck": true, /* Skip type checking of declaration files. */
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
}
}

0 comments on commit 5d9da2e

Please sign in to comment.