first commit

uni_modules/tdesign-uniapp/components/navbar/README.en-US.md

@@ -0,0 +1,76 @@
+:: BASE_DOC ::
+
+## API
+
+### Navbar Props
+
+name | type | default | description | required
+-- | -- | -- | -- | --
+custom-style | Object | - | CSS(Cascading Style Sheets) | N
+animation | Boolean | true | \- | N
+background | String | - | `deprecated`。background | N
+delta | Number | 1 | \- | N
+fixed | Boolean | true | \- | N
+home-icon | String | - | `deprecated`。homeIcon | N
+left-arrow | Boolean | false | \- | N
+left-icon | String | - | `deprecated` | N
+placeholder | Boolean | false | \- | N
+safe-area-inset-top | Boolean | true | \- | N
+title | String | - | page title | N
+title-max-length | Number | - | \- | N
+visible | Boolean | true | \- | N
+z-index | Number | 1 | \- | N
+
+### Navbar Events
+
+name | params | description
+-- | -- | --
+complete | \- | \-
+fail | \- | \-
+go-back | \- | \-
+go-home | \- | `deprecated`
+right-click | \- | \-
+success | \- | \-
+
+### Navbar Slots
+
+name | Description
+-- | --
+capsule | \-
+left | \-
+right | \-
+title | page title
+
+### Navbar External Classes
+
+className | Description
+-- | --
+t-class | \-
+t-class-capsule | \-
+t-class-center | \-
+t-class-home-icon | \-
+t-class-left | \-
+t-class-left-icon | \-
+t-class-nav-btn | \-
+t-class-title | \-
+
+### CSS Variables
+
+The component provides the following CSS variables, which can be used to customize styles.
+Name | Default Value | Description 
+-- | -- | --
+--td-navbar-padding-top | 20px | -
+--td-navbar-right | 95px | -
+--td-navbar-background | @navbar-bg-color | -
+--td-navbar-bg-color | @bg-color-container | -
+--td-navbar-capsule-border-color | @border-level-1-color | -
+--td-navbar-capsule-border-radius | 16px | -
+--td-navbar-capsule-height | 32px | -
+--td-navbar-capsule-width | 88px | -
+--td-navbar-center-left | @navbar-right | -
+--td-navbar-center-width | 187px | -
+--td-navbar-color | @text-color-primary | -
+--td-navbar-height | 48px | -
+--td-navbar-left-arrow-size | 24px | -
+--td-navbar-left-max-width | --td-navbar-left-max-width | -
+--td-navbar-title-font | @font-title-large | -