Skip to content

File Rules

📥 Import

js
import { fileRules } from 'suriform/rules'

📌 Overview

RuleDescriptionType
extMust have an allowed file extensionfile
mimesMust match allowed MIME typesfile
maxSizeMust not exceed a maximum file sizefile
minWidthImage width must be at least minimumimage
minHeightImage height must be at least minimumimage
maxWidthImage width must not exceed maximumimage
maxHeightImage height must not exceed maximumimage

📝 Examples

html
<input type="file" ext=".jpg,.png" />
<input type="file" mimes="image/jpeg,image/png" />
<input type="file" max-size="1048576" />
<input type="file" min-width="400" />
<input type="file" min-height="300" />
<input type="file" max-width="1920" />
<input type="file" max-height="1080" />

▶️ Usage

html
<form id="upload">
  <label>
    Avatar:
    <input type="file" name="avatar" ext=".jpg,.png" max-size="2097152" />
  </label>

  <label>
    Banner:
    <input type="file" name="banner" min-width="800" min-height="200" />
  </label>
</form>
js
import { watchform, defineRules } from 'suriform'
import { fileRules } from 'suriform/rules'

const form = document.querySelector('#upload')
watchform(form)
defineRules(fileRules)

Released under the MIT License.