Narwhals Poke Mammals

    @sentinel-one/ui-compodoc

    1.4.1 • Public • Published

    Angular Document Generator

    Installation

    • git clone git@github.com:Sentinel-One/ui-compodoc.git
    • npm i

    Execute

    • npm run genDoc:dev or gulp
    • npm run genDoc or gulp --env=prod

    File Structure

    .
    ├── common               * share logic\const\templates etc
    │   └── gulp             * share gulp utils\paths
    │       ├── paths.js     * gulp path for dev\prod
    │       └── utils.js     * gulp utils functionality
    ├── assets               * screen shot\images
    ├── CHANGELOG.md         * change log details
    ├── README.md            * readme file
    ├── gulpfile.js          * gulp task to generate component examples
    ├── package-lock.json    * project dependencies
    ├── package.json         * project dependencies
    └── test                 * helper for dev
    

    How to Doc

    • add decorator @ComponentDocExample({}) above @Component
    • add the component into entryComponents array in mgmt-ui.module.ts
    • execute gulp task
    • check the demo display

    Example

    @ComponentDocExample({
      navItem: {
        groupName: 'DATA TABLE',
        exampleName: 'Pagination'
      },
      demos: [
        {
          title:'Example 1'
          inputs: {
              id: 'myId',
              maxVisiblePages: 3,
              totalServerEntities: 1000,
              numOfEntityPerPage: 10,
              showPreviousAndNextText: false
            },
          executeComponentMethod: 'init'
        }
      ]
    })
    

    Publish to npm

    • update package.json version
    • push changes to git
    • execute this command npm publish --access public

    Screen Shot

    Alt text

    Keywords

    none

    Install

    npm i @sentinel-one/ui-compodoc

    DownloadsWeekly Downloads

    3

    Version

    1.4.1

    License

    ISC

    Last publish

    Collaborators

    • janhora
    • npm_service_s1
    • sivanisentinel
    • sentinelone
    • assafa
    • ofir.fridman
    • ozgonen
    • lironhazan
    • irenav
    • yoni12ab
    • koralbenami
    • liorl3009
    • gal.falah
    • amir_barak
    • matans
    • jp-s1
    • vovadev
    • yamarbel
    • shlomim-s1
    • yoavsc
    • frontend-npm-group
    • maayanb