ng-simple-file-tree - npm Package Compare versions

Comparing version 0.1.13 to 0.1.14

package.json

 {
   "name": "ng-simple-file-tree",
-  "version": "0.1.13",
+  "version": "0.1.14",
   "private": false,
@@ -5,0 +5,0 @@ "peerDependencies": {

README.md

 # Simple-file-tree
 Simple file tree for displaying files in a tree structure made with angular
+
+File tree can be configured with the following options:
+```typescript
+
+export const folderBehavior = ['select', 'expand', 'both'] as const;
+export type folderBehaviorType = typeof folderBehavior;
+
+export interface FileTreeOptions {
+  highlightOpenFolders: boolean;
+  folderBehaviourOnClick: folderBehaviorType[number];
+  hierarchyLines?: {
+    vertical?: boolean,
+    horizontal?: boolean,
+  },
+  styles?: {
+    all?: string,
+    treeItem?: {
+      default?: string,
+      active?: string,
+    },
+    treeIcon?: string,
+    chevron?: string,
+    hierarchyLine?: {
+      horizontal?: string,
+      vertical?: {
+        default?: string,
+        active?: string,
+      },
+    },
+  }
+}
+
+```
+
+Example:
+```typescript
+  options = {
+    highlightOpenFolders: false,
+    folderBehaviourOnClick: 'expand',
+    hierarchyLines: {
+      vertical: true
+    },
+    styles: {
+      all: 'font-family: consolas',
+    }
+  }
+```
+
+File extensions are automatically inferred by getting the value at the end of the filename after `.`:
+so `login.spec.js` would have extension `.js` 
+
+You can also use the determineIconClass function to add icons with any package you want, so if you use bootstrap icons you could do:
+```typescript
+function determineIcon(value: CreateTreeItem): string {
+  return 'bi bi-1-circle-fill'
+}
+```
+And if you want to add color you can define a css class with color:
+```css
+.red {
+  color: red;
+}
+```
+and then pass that class as well
+```typescript
+function determineIcon(value: CreateTreeItem): string {
+  return 'bi bi-1-circle-fill red'
+}
+```

src/app/ng-simple-file-tree/models/file-tree-options.d.ts

@@ -7,2 +7,3 @@ import { CreateTreeItem } from "./create-tree-item";
     autoSelectCondition?: (item: CreateTreeItem) => boolean;
+    determineIconClass?: (item: CreateTreeItem) => string;
     expandAllFolders?: boolean;
@@ -9,0 +10,0 @@ hierarchyLines?: {

New alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

211522

1.74%

Lines of code

1283

0.08%

Number of lines in readme file

72

2300%

Worsened metrics

Number of low supply chain risk alerts

13

44.44%

No dependency changes